Class: MicrosoftGraph::Models::User

Inherits:
DirectoryObject show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/user.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DirectoryObject

#deleted_date_time, #deleted_date_time=

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initializeObject

Instantiates a new user and sets the default values.



683
684
685
686
# File 'lib/models/user.rb', line 683

def initialize()
    super
    @odata_type = "#microsoft.graph.user"
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a user

Raises:

  • (StandardError)


767
768
769
770
# File 'lib/models/user.rb', line 767

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return User.new
end

Instance Method Details

#about_meObject

Gets the aboutMe property value. A freeform text entry field for the user to describe themselves. Returned only on $select.

Returns:

  • a string



383
384
385
# File 'lib/models/user.rb', line 383

def about_me
    return @about_me
end

#about_me=(value) ⇒ Object

Sets the aboutMe property value. A freeform text entry field for the user to describe themselves. Returned only on $select.

Parameters:

  • value

    Value to set for the aboutMe property.

Returns:

  • a void



391
392
393
# File 'lib/models/user.rb', line 391

def about_me=(value)
    @about_me = value
end

#account_enabledObject

Gets the accountEnabled property value. true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on $select. Supports $filter (eq, ne, not, and in).

Returns:

  • a boolean



398
399
400
# File 'lib/models/user.rb', line 398

def 
    return @account_enabled
end

#account_enabled=(value) ⇒ Object

Sets the accountEnabled property value. true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on $select. Supports $filter (eq, ne, not, and in).

Parameters:

  • value

    Value to set for the accountEnabled property.

Returns:

  • a void



406
407
408
# File 'lib/models/user.rb', line 406

def (value)
    @account_enabled = value
end

#activitiesObject

Gets the activities property value. The user’s activities across devices. Read-only. Nullable.

Returns:

  • a user_activity



413
414
415
# File 'lib/models/user.rb', line 413

def activities
    return @activities
end

#activities=(value) ⇒ Object

Sets the activities property value. The user’s activities across devices. Read-only. Nullable.

Parameters:

  • value

    Value to set for the activities property.

Returns:

  • a void



421
422
423
# File 'lib/models/user.rb', line 421

def activities=(value)
    @activities = value
end

#age_groupObject

Gets the ageGroup property value. Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).

Returns:

  • a string



428
429
430
# File 'lib/models/user.rb', line 428

def age_group
    return @age_group
end

#age_group=(value) ⇒ Object

Sets the ageGroup property value. Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).

Parameters:

  • value

    Value to set for the ageGroup property.

Returns:

  • a void



436
437
438
# File 'lib/models/user.rb', line 436

def age_group=(value)
    @age_group = value
end

#agreement_acceptancesObject

Gets the agreementAcceptances property value. The user’s terms of use acceptance statuses. Read-only. Nullable.

Returns:

  • a agreement_acceptance



443
444
445
# File 'lib/models/user.rb', line 443

def agreement_acceptances
    return @agreement_acceptances
end

#agreement_acceptances=(value) ⇒ Object

Sets the agreementAcceptances property value. The user’s terms of use acceptance statuses. Read-only. Nullable.

Parameters:

  • value

    Value to set for the agreementAcceptances property.

Returns:

  • a void



451
452
453
# File 'lib/models/user.rb', line 451

def agreement_acceptances=(value)
    @agreement_acceptances = value
end

#app_role_assignmentsObject

Gets the appRoleAssignments property value. Represents the app roles a user has been granted for an application. Supports $expand.

Returns:

  • a app_role_assignment



458
459
460
# File 'lib/models/user.rb', line 458

def app_role_assignments
    return @app_role_assignments
end

#app_role_assignments=(value) ⇒ Object

Sets the appRoleAssignments property value. Represents the app roles a user has been granted for an application. Supports $expand.

Parameters:

  • value

    Value to set for the appRoleAssignments property.

Returns:

  • a void



466
467
468
# File 'lib/models/user.rb', line 466

def app_role_assignments=(value)
    @app_role_assignments = value
end

#assigned_licensesObject

Gets the assignedLicenses property value. The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn’t differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).

Returns:

  • a assigned_license



473
474
475
# File 'lib/models/user.rb', line 473

def assigned_licenses
    return @assigned_licenses
end

#assigned_licenses=(value) ⇒ Object

Sets the assignedLicenses property value. The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn’t differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).

Parameters:

  • value

    Value to set for the assignedLicenses property.

Returns:

  • a void



481
482
483
# File 'lib/models/user.rb', line 481

def assigned_licenses=(value)
    @assigned_licenses = value
end

#assigned_plansObject

Gets the assignedPlans property value. The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not).

Returns:

  • a assigned_plan



488
489
490
# File 'lib/models/user.rb', line 488

def assigned_plans
    return @assigned_plans
end

#assigned_plans=(value) ⇒ Object

Sets the assignedPlans property value. The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not).

Parameters:

  • value

    Value to set for the assignedPlans property.

Returns:

  • a void



496
497
498
# File 'lib/models/user.rb', line 496

def assigned_plans=(value)
    @assigned_plans = value
end

#authenticationObject

Gets the authentication property value. The authentication methods that are supported for the user.

Returns:

  • a authentication



503
504
505
# File 'lib/models/user.rb', line 503

def authentication
    return @authentication
end

#authentication=(value) ⇒ Object

Sets the authentication property value. The authentication methods that are supported for the user.

Parameters:

  • value

    Value to set for the authentication property.

Returns:

  • a void



511
512
513
# File 'lib/models/user.rb', line 511

def authentication=(value)
    @authentication = value
end

#authorization_infoObject

Gets the authorizationInfo property value. The authorizationInfo property

Returns:

  • a authorization_info



518
519
520
# File 'lib/models/user.rb', line 518

def authorization_info
    return @authorization_info
end

#authorization_info=(value) ⇒ Object

Sets the authorizationInfo property value. The authorizationInfo property

Parameters:

  • value

    Value to set for the authorizationInfo property.

Returns:

  • a void



526
527
528
# File 'lib/models/user.rb', line 526

def authorization_info=(value)
    @authorization_info = value
end

#birthdayObject

Gets the birthday property value. The birthday 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. Returned only on $select.

Returns:

  • a date_time



533
534
535
# File 'lib/models/user.rb', line 533

def birthday
    return @birthday
end

#birthday=(value) ⇒ Object

Sets the birthday property value. The birthday 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. Returned only on $select.

Parameters:

  • value

    Value to set for the birthday property.

Returns:

  • a void



541
542
543
# File 'lib/models/user.rb', line 541

def birthday=(value)
    @birthday = value
end

#business_phonesObject

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. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith).

Returns:

  • a string



548
549
550
# File 'lib/models/user.rb', line 548

def business_phones
    return @business_phones
end

#business_phones=(value) ⇒ Object

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. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith).

Parameters:

  • value

    Value to set for the businessPhones property.

Returns:

  • a void



556
557
558
# File 'lib/models/user.rb', line 556

def business_phones=(value)
    @business_phones = value
end

#calendarObject

Gets the calendar property value. The user’s primary calendar. Read-only.

Returns:

  • a calendar



563
564
565
# File 'lib/models/user.rb', line 563

def calendar
    return @calendar
end

#calendar=(value) ⇒ Object

Sets the calendar property value. The user’s primary calendar. Read-only.

Parameters:

  • value

    Value to set for the calendar property.

Returns:

  • a void



571
572
573
# File 'lib/models/user.rb', line 571

def calendar=(value)
    @calendar = value
end

#calendar_groupsObject

Gets the calendarGroups property value. The user’s calendar groups. Read-only. Nullable.

Returns:

  • a calendar_group



578
579
580
# File 'lib/models/user.rb', line 578

def calendar_groups
    return @calendar_groups
end

#calendar_groups=(value) ⇒ Object

Sets the calendarGroups property value. The user’s calendar groups. Read-only. Nullable.

Parameters:

  • value

    Value to set for the calendarGroups property.

Returns:

  • a void



586
587
588
# File 'lib/models/user.rb', line 586

def calendar_groups=(value)
    @calendar_groups = value
end

#calendar_viewObject

Gets the calendarView property value. The calendar view for the calendar. Read-only. Nullable.

Returns:

  • a event



593
594
595
# File 'lib/models/user.rb', line 593

def calendar_view
    return @calendar_view
end

#calendar_view=(value) ⇒ Object

Sets the calendarView property value. The calendar view for the calendar. Read-only. Nullable.

Parameters:

  • value

    Value to set for the calendarView property.

Returns:

  • a void



601
602
603
# File 'lib/models/user.rb', line 601

def calendar_view=(value)
    @calendar_view = value
end

#calendarsObject

Gets the calendars property value. The user’s calendars. Read-only. Nullable.

Returns:

  • a calendar



608
609
610
# File 'lib/models/user.rb', line 608

def calendars
    return @calendars
end

#calendars=(value) ⇒ Object

Sets the calendars property value. The user’s calendars. Read-only. Nullable.

Parameters:

  • value

    Value to set for the calendars property.

Returns:

  • a void



616
617
618
# File 'lib/models/user.rb', line 616

def calendars=(value)
    @calendars = value
end

#chatsObject

Gets the chats property value. The chats property

Returns:

  • a chat



623
624
625
# File 'lib/models/user.rb', line 623

def chats
    return @chats
end

#chats=(value) ⇒ Object

Sets the chats property value. The chats property

Parameters:

  • value

    Value to set for the chats property.

Returns:

  • a void



631
632
633
# File 'lib/models/user.rb', line 631

def chats=(value)
    @chats = value
end

#cityObject

Gets the city property value. The city in which the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



638
639
640
# File 'lib/models/user.rb', line 638

def city
    return @city
end

#city=(value) ⇒ Object

Sets the city property value. The city in which the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the city property.

Returns:

  • a void



646
647
648
# File 'lib/models/user.rb', line 646

def city=(value)
    @city = value
end

#company_nameObject

Gets the companyName property value. The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



653
654
655
# File 'lib/models/user.rb', line 653

def company_name
    return @company_name
end

#company_name=(value) ⇒ Object

Sets the companyName property value. The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the companyName property.

Returns:

  • a void



661
662
663
# File 'lib/models/user.rb', line 661

def company_name=(value)
    @company_name = value
end

Gets the consentProvidedForMinor property value. Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).

Returns:

  • a string



668
669
670
# File 'lib/models/user.rb', line 668

def consent_provided_for_minor
    return @consent_provided_for_minor
end

Sets the consentProvidedForMinor property value. Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).

Parameters:

  • value

    Value to set for the consentProvidedForMinor property.

Returns:

  • a void



676
677
678
# File 'lib/models/user.rb', line 676

def consent_provided_for_minor=(value)
    @consent_provided_for_minor = value
end

#contact_foldersObject

Gets the contactFolders property value. The user’s contacts folders. Read-only. Nullable.

Returns:

  • a contact_folder



691
692
693
# File 'lib/models/user.rb', line 691

def contact_folders
    return @contact_folders
end

#contact_folders=(value) ⇒ Object

Sets the contactFolders property value. The user’s contacts folders. Read-only. Nullable.

Parameters:

  • value

    Value to set for the contactFolders property.

Returns:

  • a void



699
700
701
# File 'lib/models/user.rb', line 699

def contact_folders=(value)
    @contact_folders = value
end

#contactsObject

Gets the contacts property value. The user’s contacts. Read-only. Nullable.

Returns:

  • a contact



706
707
708
# File 'lib/models/user.rb', line 706

def contacts
    return @contacts
end

#contacts=(value) ⇒ Object

Sets the contacts property value. The user’s contacts. Read-only. Nullable.

Parameters:

  • value

    Value to set for the contacts property.

Returns:

  • a void



714
715
716
# File 'lib/models/user.rb', line 714

def contacts=(value)
    @contacts = value
end

#countryObject

Gets the country property value. The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



721
722
723
# File 'lib/models/user.rb', line 721

def country
    return @country
end

#country=(value) ⇒ Object

Sets the country property value. The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the country property.

Returns:

  • a void



729
730
731
# File 'lib/models/user.rb', line 729

def country=(value)
    @country = value
end

#created_date_timeObject

Gets the createdDateTime property value. The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).

Returns:

  • a date_time



736
737
738
# File 'lib/models/user.rb', line 736

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).

Parameters:

  • value

    Value to set for the createdDateTime property.

Returns:

  • a void



744
745
746
# File 'lib/models/user.rb', line 744

def created_date_time=(value)
    @created_date_time = value
end

#created_objectsObject

Gets the createdObjects property value. Directory objects that were created by the user. Read-only. Nullable.

Returns:

  • a directory_object



751
752
753
# File 'lib/models/user.rb', line 751

def created_objects
    return @created_objects
end

#created_objects=(value) ⇒ Object

Sets the createdObjects property value. Directory objects that were created by the user. Read-only. Nullable.

Parameters:

  • value

    Value to set for the createdObjects property.

Returns:

  • a void



759
760
761
# File 'lib/models/user.rb', line 759

def created_objects=(value)
    @created_objects = value
end

#creation_typeObject

Gets the creationType property value. Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, not, in).

Returns:

  • a string



775
776
777
# File 'lib/models/user.rb', line 775

def creation_type
    return @creation_type
end

#creation_type=(value) ⇒ Object

Sets the creationType property value. Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, not, in).

Parameters:

  • value

    Value to set for the creationType property.

Returns:

  • a void



783
784
785
# File 'lib/models/user.rb', line 783

def creation_type=(value)
    @creation_type = value
end

#custom_security_attributesObject

Gets the customSecurityAttributes property value. The customSecurityAttributes property

Returns:

  • a custom_security_attribute_value



790
791
792
# File 'lib/models/user.rb', line 790

def custom_security_attributes
    return @custom_security_attributes
end

#custom_security_attributes=(value) ⇒ Object

Sets the customSecurityAttributes property value. The customSecurityAttributes property

Parameters:

  • value

    Value to set for the customSecurityAttributes property.

Returns:

  • a void



798
799
800
# File 'lib/models/user.rb', line 798

def custom_security_attributes=(value)
    @custom_security_attributes = value
end

#departmentObject

Gets the department property value. The name for the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).

Returns:

  • a string



805
806
807
# File 'lib/models/user.rb', line 805

def department
    return @department
end

#department=(value) ⇒ Object

Sets the department property value. The name for the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).

Parameters:

  • value

    Value to set for the department property.

Returns:

  • a void



813
814
815
# File 'lib/models/user.rb', line 813

def department=(value)
    @department = value
end

#device_enrollment_limitObject

Gets the deviceEnrollmentLimit property value. The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.

Returns:

  • a integer



820
821
822
# File 'lib/models/user.rb', line 820

def device_enrollment_limit
    return @device_enrollment_limit
end

#device_enrollment_limit=(value) ⇒ Object

Sets the deviceEnrollmentLimit property value. The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.

Parameters:

  • value

    Value to set for the deviceEnrollmentLimit property.

Returns:

  • a void



828
829
830
# File 'lib/models/user.rb', line 828

def device_enrollment_limit=(value)
    @device_enrollment_limit = value
end

#device_management_troubleshooting_eventsObject

Gets the deviceManagementTroubleshootingEvents property value. The list of troubleshooting events for this user.

Returns:

  • a device_management_troubleshooting_event



835
836
837
# File 'lib/models/user.rb', line 835

def device_management_troubleshooting_events
    return @device_management_troubleshooting_events
end

#device_management_troubleshooting_events=(value) ⇒ Object

Sets the deviceManagementTroubleshootingEvents property value. The list of troubleshooting events for this user.

Parameters:

  • value

    Value to set for the deviceManagementTroubleshootingEvents property.

Returns:

  • a void



843
844
845
# File 'lib/models/user.rb', line 843

def device_management_troubleshooting_events=(value)
    @device_management_troubleshooting_events = value
end

#direct_reportsObject

Gets the directReports property value. The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.

Returns:

  • a directory_object



850
851
852
# File 'lib/models/user.rb', line 850

def direct_reports
    return @direct_reports
end

#direct_reports=(value) ⇒ Object

Sets the directReports property value. The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.

Parameters:

  • value

    Value to set for the directReports property.

Returns:

  • a void



858
859
860
# File 'lib/models/user.rb', line 858

def direct_reports=(value)
    @direct_reports = value
end

#display_nameObject

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. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.

Returns:

  • a string



865
866
867
# File 'lib/models/user.rb', line 865

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

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. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.

Parameters:

  • value

    Value to set for the displayName property.

Returns:

  • a void



873
874
875
# File 'lib/models/user.rb', line 873

def display_name=(value)
    @display_name = value
end

#driveObject

Gets the drive property value. The user’s OneDrive. Read-only.

Returns:

  • a drive



880
881
882
# File 'lib/models/user.rb', line 880

def drive
    return @drive
end

#drive=(value) ⇒ Object

Sets the drive property value. The user’s OneDrive. Read-only.

Parameters:

  • value

    Value to set for the drive property.

Returns:

  • a void



888
889
890
# File 'lib/models/user.rb', line 888

def drive=(value)
    @drive = value
end

#drivesObject

Gets the drives property value. A collection of drives available for this user. Read-only.

Returns:

  • a drive



895
896
897
# File 'lib/models/user.rb', line 895

def drives
    return @drives
end

#drives=(value) ⇒ Object

Sets the drives property value. A collection of drives available for this user. Read-only.

Parameters:

  • value

    Value to set for the drives property.

Returns:

  • a void



903
904
905
# File 'lib/models/user.rb', line 903

def drives=(value)
    @drives = value
end

#employee_experienceObject

Gets the employeeExperience property value. The employeeExperience property

Returns:

  • a employee_experience_user



910
911
912
# File 'lib/models/user.rb', line 910

def employee_experience
    return @employee_experience
end

#employee_experience=(value) ⇒ Object

Sets the employeeExperience property value. The employeeExperience property

Parameters:

  • value

    Value to set for the employeeExperience property.

Returns:

  • a void



918
919
920
# File 'lib/models/user.rb', line 918

def employee_experience=(value)
    @employee_experience = value
end

#employee_hire_dateObject

Gets the employeeHireDate property value. The date and time when the user was hired or will start work in case of a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).

Returns:

  • a date_time



925
926
927
# File 'lib/models/user.rb', line 925

def employee_hire_date
    return @employee_hire_date
end

#employee_hire_date=(value) ⇒ Object

Sets the employeeHireDate property value. The date and time when the user was hired or will start work in case of a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).

Parameters:

  • value

    Value to set for the employeeHireDate property.

Returns:

  • a void



933
934
935
# File 'lib/models/user.rb', line 933

def employee_hire_date=(value)
    @employee_hire_date = value
end

#employee_idObject

Gets the employeeId property value. The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



940
941
942
# File 'lib/models/user.rb', line 940

def employee_id
    return @employee_id
end

#employee_id=(value) ⇒ Object

Sets the employeeId property value. The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the employeeId property.

Returns:

  • a void



948
949
950
# File 'lib/models/user.rb', line 948

def employee_id=(value)
    @employee_id = value
end

#employee_leave_date_timeObject

Gets the employeeLeaveDateTime property value. The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs one of the following Azure AD roles: Lifecycle Workflows Administrator, Global Reader, or Global Administrator. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.

Returns:

  • a date_time



955
956
957
# File 'lib/models/user.rb', line 955

def employee_leave_date_time
    return @employee_leave_date_time
end

#employee_leave_date_time=(value) ⇒ Object

Sets the employeeLeaveDateTime property value. The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs one of the following Azure AD roles: Lifecycle Workflows Administrator, Global Reader, or Global Administrator. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.

Parameters:

  • value

    Value to set for the employeeLeaveDateTime property.

Returns:

  • a void



963
964
965
# File 'lib/models/user.rb', line 963

def employee_leave_date_time=(value)
    @employee_leave_date_time = value
end

#employee_org_dataObject

Gets the employeeOrgData property value. Represents organization data (e.g. division and costCenter) associated with a user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).

Returns:

  • a employee_org_data



970
971
972
# File 'lib/models/user.rb', line 970

def employee_org_data
    return @employee_org_data
end

#employee_org_data=(value) ⇒ Object

Sets the employeeOrgData property value. Represents organization data (e.g. division and costCenter) associated with a user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).

Parameters:

  • value

    Value to set for the employeeOrgData property.

Returns:

  • a void



978
979
980
# File 'lib/models/user.rb', line 978

def employee_org_data=(value)
    @employee_org_data = value
end

#employee_typeObject

Gets the employeeType property value. Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).

Returns:

  • a string



985
986
987
# File 'lib/models/user.rb', line 985

def employee_type
    return @employee_type
end

#employee_type=(value) ⇒ Object

Sets the employeeType property value. Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).

Parameters:

  • value

    Value to set for the employeeType property.

Returns:

  • a void



993
994
995
# File 'lib/models/user.rb', line 993

def employee_type=(value)
    @employee_type = value
end

#eventsObject

Gets the events property value. The user’s events. Default is to show Events under the Default Calendar. Read-only. Nullable.

Returns:

  • a event



1000
1001
1002
# File 'lib/models/user.rb', line 1000

def events
    return @events
end

#events=(value) ⇒ Object

Sets the events property value. The user’s events. Default is to show Events under the Default Calendar. Read-only. Nullable.

Parameters:

  • value

    Value to set for the events property.

Returns:

  • a void



1008
1009
1010
# File 'lib/models/user.rb', line 1008

def events=(value)
    @events = value
end

#extensionsObject

Gets the extensions property value. The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.

Returns:

  • a extension



1015
1016
1017
# File 'lib/models/user.rb', line 1015

def extensions
    return @extensions
end

#extensions=(value) ⇒ Object

Sets the extensions property value. The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.

Parameters:

  • value

    Value to set for the extensions property.

Returns:

  • a void



1023
1024
1025
# File 'lib/models/user.rb', line 1023

def extensions=(value)
    @extensions = value
end

#external_user_stateObject

Gets the externalUserState property value. For an external user invited to the tenant using the invitation API, this property represents the invited user’s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in).

Returns:

  • a string



1030
1031
1032
# File 'lib/models/user.rb', line 1030

def external_user_state
    return @external_user_state
end

#external_user_state=(value) ⇒ Object

Sets the externalUserState property value. For an external user invited to the tenant using the invitation API, this property represents the invited user’s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in).

Parameters:

  • value

    Value to set for the externalUserState property.

Returns:

  • a void



1038
1039
1040
# File 'lib/models/user.rb', line 1038

def external_user_state=(value)
    @external_user_state = value
end

#external_user_state_change_date_timeObject

Gets the externalUserStateChangeDateTime property value. Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in).

Returns:

  • a date_time



1045
1046
1047
# File 'lib/models/user.rb', line 1045

def external_user_state_change_date_time
    return @external_user_state_change_date_time
end

#external_user_state_change_date_time=(value) ⇒ Object

Sets the externalUserStateChangeDateTime property value. Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in).

Parameters:

  • value

    Value to set for the externalUserStateChangeDateTime property.

Returns:

  • a void



1053
1054
1055
# File 'lib/models/user.rb', line 1053

def external_user_state_change_date_time=(value)
    @external_user_state_change_date_time = value
end

#fax_numberObject

Gets the faxNumber property value. The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1060
1061
1062
# File 'lib/models/user.rb', line 1060

def fax_number
    return @fax_number
end

#fax_number=(value) ⇒ Object

Sets the faxNumber property value. The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the faxNumber property.

Returns:

  • a void



1068
1069
1070
# File 'lib/models/user.rb', line 1068

def fax_number=(value)
    @fax_number = value
end

#followed_sitesObject

Gets the followedSites property value. The followedSites property

Returns:

  • a site



1075
1076
1077
# File 'lib/models/user.rb', line 1075

def followed_sites
    return @followed_sites
end

#followed_sites=(value) ⇒ Object

Sets the followedSites property value. The followedSites property

Parameters:

  • value

    Value to set for the followedSites property.

Returns:

  • a void



1083
1084
1085
# File 'lib/models/user.rb', line 1083

def followed_sites=(value)
    @followed_sites = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'lib/models/user.rb', line 1090

def get_field_deserializers()
    return super.merge({
        "aboutMe" => lambda {|n| @about_me = n.get_string_value() },
        "accountEnabled" => lambda {|n| @account_enabled = n.get_boolean_value() },
        "activities" => lambda {|n| @activities = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::UserActivity.create_from_discriminator_value(pn) }) },
        "ageGroup" => lambda {|n| @age_group = n.get_string_value() },
        "agreementAcceptances" => lambda {|n| @agreement_acceptances = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AgreementAcceptance.create_from_discriminator_value(pn) }) },
        "appRoleAssignments" => lambda {|n| @app_role_assignments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AppRoleAssignment.create_from_discriminator_value(pn) }) },
        "assignedLicenses" => lambda {|n| @assigned_licenses = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AssignedLicense.create_from_discriminator_value(pn) }) },
        "assignedPlans" => lambda {|n| @assigned_plans = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AssignedPlan.create_from_discriminator_value(pn) }) },
        "authentication" => lambda {|n| @authentication = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Authentication.create_from_discriminator_value(pn) }) },
        "authorizationInfo" => lambda {|n| @authorization_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AuthorizationInfo.create_from_discriminator_value(pn) }) },
        "birthday" => lambda {|n| @birthday = n.get_date_time_value() },
        "businessPhones" => lambda {|n| @business_phones = n.get_collection_of_primitive_values(String) },
        "calendar" => lambda {|n| @calendar = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Calendar.create_from_discriminator_value(pn) }) },
        "calendarGroups" => lambda {|n| @calendar_groups = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::CalendarGroup.create_from_discriminator_value(pn) }) },
        "calendarView" => lambda {|n| @calendar_view = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Event.create_from_discriminator_value(pn) }) },
        "calendars" => lambda {|n| @calendars = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Calendar.create_from_discriminator_value(pn) }) },
        "chats" => lambda {|n| @chats = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Chat.create_from_discriminator_value(pn) }) },
        "city" => lambda {|n| @city = n.get_string_value() },
        "companyName" => lambda {|n| @company_name = n.get_string_value() },
        "consentProvidedForMinor" => lambda {|n| @consent_provided_for_minor = n.get_string_value() },
        "contactFolders" => lambda {|n| @contact_folders = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ContactFolder.create_from_discriminator_value(pn) }) },
        "contacts" => lambda {|n| @contacts = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Contact.create_from_discriminator_value(pn) }) },
        "country" => lambda {|n| @country = n.get_string_value() },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "createdObjects" => lambda {|n| @created_objects = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "creationType" => lambda {|n| @creation_type = n.get_string_value() },
        "customSecurityAttributes" => lambda {|n| @custom_security_attributes = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::CustomSecurityAttributeValue.create_from_discriminator_value(pn) }) },
        "department" => lambda {|n| @department = n.get_string_value() },
        "deviceEnrollmentLimit" => lambda {|n| @device_enrollment_limit = n.get_number_value() },
        "deviceManagementTroubleshootingEvents" => lambda {|n| @device_management_troubleshooting_events = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DeviceManagementTroubleshootingEvent.create_from_discriminator_value(pn) }) },
        "directReports" => lambda {|n| @direct_reports = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "drive" => lambda {|n| @drive = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Drive.create_from_discriminator_value(pn) }) },
        "drives" => lambda {|n| @drives = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Drive.create_from_discriminator_value(pn) }) },
        "employeeExperience" => lambda {|n| @employee_experience = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EmployeeExperienceUser.create_from_discriminator_value(pn) }) },
        "employeeHireDate" => lambda {|n| @employee_hire_date = n.get_date_time_value() },
        "employeeId" => lambda {|n| @employee_id = n.get_string_value() },
        "employeeLeaveDateTime" => lambda {|n| @employee_leave_date_time = n.get_date_time_value() },
        "employeeOrgData" => lambda {|n| @employee_org_data = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EmployeeOrgData.create_from_discriminator_value(pn) }) },
        "employeeType" => lambda {|n| @employee_type = n.get_string_value() },
        "events" => lambda {|n| @events = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Event.create_from_discriminator_value(pn) }) },
        "extensions" => lambda {|n| @extensions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Extension.create_from_discriminator_value(pn) }) },
        "externalUserState" => lambda {|n| @external_user_state = n.get_string_value() },
        "externalUserStateChangeDateTime" => lambda {|n| @external_user_state_change_date_time = n.get_date_time_value() },
        "faxNumber" => lambda {|n| @fax_number = n.get_string_value() },
        "followedSites" => lambda {|n| @followed_sites = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Site.create_from_discriminator_value(pn) }) },
        "givenName" => lambda {|n| @given_name = n.get_string_value() },
        "hireDate" => lambda {|n| @hire_date = n.get_date_time_value() },
        "identities" => lambda {|n| @identities = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ObjectIdentity.create_from_discriminator_value(pn) }) },
        "imAddresses" => lambda {|n| @im_addresses = n.get_collection_of_primitive_values(String) },
        "inferenceClassification" => lambda {|n| @inference_classification = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::InferenceClassification.create_from_discriminator_value(pn) }) },
        "insights" => lambda {|n| @insights = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::OfficeGraphInsights.create_from_discriminator_value(pn) }) },
        "interests" => lambda {|n| @interests = n.get_collection_of_primitive_values(String) },
        "isResourceAccount" => lambda {|n| @is_resource_account = n.get_boolean_value() },
        "jobTitle" => lambda {|n| @job_title = n.get_string_value() },
        "joinedTeams" => lambda {|n| @joined_teams = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Team.create_from_discriminator_value(pn) }) },
        "lastPasswordChangeDateTime" => lambda {|n| @last_password_change_date_time = n.get_date_time_value() },
        "legalAgeGroupClassification" => lambda {|n| @legal_age_group_classification = n.get_string_value() },
        "licenseAssignmentStates" => lambda {|n| @license_assignment_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::LicenseAssignmentState.create_from_discriminator_value(pn) }) },
        "licenseDetails" => lambda {|n| @license_details = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::LicenseDetails.create_from_discriminator_value(pn) }) },
        "mail" => lambda {|n| @mail = n.get_string_value() },
        "mailFolders" => lambda {|n| @mail_folders = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::MailFolder.create_from_discriminator_value(pn) }) },
        "mailNickname" => lambda {|n| @mail_nickname = n.get_string_value() },
        "mailboxSettings" => lambda {|n| @mailbox_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::MailboxSettings.create_from_discriminator_value(pn) }) },
        "managedAppRegistrations" => lambda {|n| @managed_app_registrations = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ManagedAppRegistration.create_from_discriminator_value(pn) }) },
        "managedDevices" => lambda {|n| @managed_devices = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ManagedDevice.create_from_discriminator_value(pn) }) },
        "manager" => lambda {|n| @manager = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "memberOf" => lambda {|n| @member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "messages" => lambda {|n| @messages = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Message.create_from_discriminator_value(pn) }) },
        "mobilePhone" => lambda {|n| @mobile_phone = n.get_string_value() },
        "mySite" => lambda {|n| @my_site = n.get_string_value() },
        "oauth2PermissionGrants" => lambda {|n| @oauth2_permission_grants = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::OAuth2PermissionGrant.create_from_discriminator_value(pn) }) },
        "officeLocation" => lambda {|n| @office_location = n.get_string_value() },
        "onPremisesDistinguishedName" => lambda {|n| @on_premises_distinguished_name = n.get_string_value() },
        "onPremisesDomainName" => lambda {|n| @on_premises_domain_name = n.get_string_value() },
        "onPremisesExtensionAttributes" => lambda {|n| @on_premises_extension_attributes = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::OnPremisesExtensionAttributes.create_from_discriminator_value(pn) }) },
        "onPremisesImmutableId" => lambda {|n| @on_premises_immutable_id = n.get_string_value() },
        "onPremisesLastSyncDateTime" => lambda {|n| @on_premises_last_sync_date_time = n.get_date_time_value() },
        "onPremisesProvisioningErrors" => lambda {|n| @on_premises_provisioning_errors = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::OnPremisesProvisioningError.create_from_discriminator_value(pn) }) },
        "onPremisesSamAccountName" => lambda {|n| @on_premises_sam_account_name = n.get_string_value() },
        "onPremisesSecurityIdentifier" => lambda {|n| @on_premises_security_identifier = n.get_string_value() },
        "onPremisesSyncEnabled" => lambda {|n| @on_premises_sync_enabled = n.get_boolean_value() },
        "onPremisesUserPrincipalName" => lambda {|n| @on_premises_user_principal_name = n.get_string_value() },
        "onenote" => lambda {|n| @onenote = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Onenote.create_from_discriminator_value(pn) }) },
        "onlineMeetings" => lambda {|n| @online_meetings = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::OnlineMeeting.create_from_discriminator_value(pn) }) },
        "otherMails" => lambda {|n| @other_mails = n.get_collection_of_primitive_values(String) },
        "outlook" => lambda {|n| @outlook = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::OutlookUser.create_from_discriminator_value(pn) }) },
        "ownedDevices" => lambda {|n| @owned_devices = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "ownedObjects" => lambda {|n| @owned_objects = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "passwordPolicies" => lambda {|n| @password_policies = n.get_string_value() },
        "passwordProfile" => lambda {|n| @password_profile = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PasswordProfile.create_from_discriminator_value(pn) }) },
        "pastProjects" => lambda {|n| @past_projects = n.get_collection_of_primitive_values(String) },
        "people" => lambda {|n| @people = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Person.create_from_discriminator_value(pn) }) },
        "photo" => lambda {|n| @photo = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ProfilePhoto.create_from_discriminator_value(pn) }) },
        "photos" => lambda {|n| @photos = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ProfilePhoto.create_from_discriminator_value(pn) }) },
        "planner" => lambda {|n| @planner = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerUser.create_from_discriminator_value(pn) }) },
        "postalCode" => lambda {|n| @postal_code = n.get_string_value() },
        "preferredDataLocation" => lambda {|n| @preferred_data_location = n.get_string_value() },
        "preferredLanguage" => lambda {|n| @preferred_language = n.get_string_value() },
        "preferredName" => lambda {|n| @preferred_name = n.get_string_value() },
        "presence" => lambda {|n| @presence = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Presence.create_from_discriminator_value(pn) }) },
        "print" => lambda {|n| @print = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::UserPrint.create_from_discriminator_value(pn) }) },
        "provisionedPlans" => lambda {|n| @provisioned_plans = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ProvisionedPlan.create_from_discriminator_value(pn) }) },
        "proxyAddresses" => lambda {|n| @proxy_addresses = n.get_collection_of_primitive_values(String) },
        "registeredDevices" => lambda {|n| @registered_devices = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "responsibilities" => lambda {|n| @responsibilities = n.get_collection_of_primitive_values(String) },
        "schools" => lambda {|n| @schools = n.get_collection_of_primitive_values(String) },
        "scopedRoleMemberOf" => lambda {|n| @scoped_role_member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ScopedRoleMembership.create_from_discriminator_value(pn) }) },
        "securityIdentifier" => lambda {|n| @security_identifier = n.get_string_value() },
        "settings" => lambda {|n| @settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::UserSettings.create_from_discriminator_value(pn) }) },
        "showInAddressList" => lambda {|n| @show_in_address_list = n.get_boolean_value() },
        "signInActivity" => lambda {|n| @sign_in_activity = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SignInActivity.create_from_discriminator_value(pn) }) },
        "signInSessionsValidFromDateTime" => lambda {|n| @sign_in_sessions_valid_from_date_time = n.get_date_time_value() },
        "skills" => lambda {|n| @skills = n.get_collection_of_primitive_values(String) },
        "state" => lambda {|n| @state = n.get_string_value() },
        "streetAddress" => lambda {|n| @street_address = n.get_string_value() },
        "surname" => lambda {|n| @surname = n.get_string_value() },
        "teamwork" => lambda {|n| @teamwork = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::UserTeamwork.create_from_discriminator_value(pn) }) },
        "todo" => lambda {|n| @todo = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Todo.create_from_discriminator_value(pn) }) },
        "transitiveMemberOf" => lambda {|n| @transitive_member_of = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "usageLocation" => lambda {|n| @usage_location = n.get_string_value() },
        "userPrincipalName" => lambda {|n| @user_principal_name = n.get_string_value() },
        "userType" => lambda {|n| @user_type = n.get_string_value() },
    })
end

#given_nameObject

Gets the givenName property value. The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1221
1222
1223
# File 'lib/models/user.rb', line 1221

def given_name
    return @given_name
end

#given_name=(value) ⇒ Object

Sets the givenName property value. The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the givenName property.

Returns:

  • a void



1229
1230
1231
# File 'lib/models/user.rb', line 1229

def given_name=(value)
    @given_name = value
end

#hire_dateObject

Gets the hireDate property value. 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. Returned only on $select. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.

Returns:

  • a date_time



1236
1237
1238
# File 'lib/models/user.rb', line 1236

def hire_date
    return @hire_date
end

#hire_date=(value) ⇒ Object

Sets the hireDate property value. 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. Returned only on $select. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.

Parameters:

  • value

    Value to set for the hireDate property.

Returns:

  • a void



1244
1245
1246
# File 'lib/models/user.rb', line 1244

def hire_date=(value)
    @hire_date = value
end

#identitiesObject

Gets the identities property value. Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.

Returns:

  • a object_identity



1251
1252
1253
# File 'lib/models/user.rb', line 1251

def identities
    return @identities
end

#identities=(value) ⇒ Object

Sets the identities property value. Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.

Parameters:

  • value

    Value to set for the identities property.

Returns:

  • a void



1259
1260
1261
# File 'lib/models/user.rb', line 1259

def identities=(value)
    @identities = value
end

#im_addressesObject

Gets the imAddresses property value. The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).

Returns:

  • a string



1266
1267
1268
# File 'lib/models/user.rb', line 1266

def im_addresses
    return @im_addresses
end

#im_addresses=(value) ⇒ Object

Sets the imAddresses property value. The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).

Parameters:

  • value

    Value to set for the imAddresses property.

Returns:

  • a void



1274
1275
1276
# File 'lib/models/user.rb', line 1274

def im_addresses=(value)
    @im_addresses = value
end

#inference_classificationObject

Gets the inferenceClassification property value. Relevance classification of the user’s messages based on explicit designations which override inferred relevance or importance.

Returns:

  • a inference_classification



1281
1282
1283
# File 'lib/models/user.rb', line 1281

def inference_classification
    return @inference_classification
end

#inference_classification=(value) ⇒ Object

Sets the inferenceClassification property value. Relevance classification of the user’s messages based on explicit designations which override inferred relevance or importance.

Parameters:

  • value

    Value to set for the inferenceClassification property.

Returns:

  • a void



1289
1290
1291
# File 'lib/models/user.rb', line 1289

def inference_classification=(value)
    @inference_classification = value
end

#insightsObject

Gets the insights property value. The insights property

Returns:

  • a office_graph_insights



1296
1297
1298
# File 'lib/models/user.rb', line 1296

def insights
    return @insights
end

#insights=(value) ⇒ Object

Sets the insights property value. The insights property

Parameters:

  • value

    Value to set for the insights property.

Returns:

  • a void



1304
1305
1306
# File 'lib/models/user.rb', line 1304

def insights=(value)
    @insights = value
end

#interestsObject

Gets the interests property value. A list for the user to describe their interests. Returned only on $select.

Returns:

  • a string



1311
1312
1313
# File 'lib/models/user.rb', line 1311

def interests
    return @interests
end

#interests=(value) ⇒ Object

Sets the interests property value. A list for the user to describe their interests. Returned only on $select.

Parameters:

  • value

    Value to set for the interests property.

Returns:

  • a void



1319
1320
1321
# File 'lib/models/user.rb', line 1319

def interests=(value)
    @interests = value
end

#is_resource_accountObject

Gets the isResourceAccount property value. Do not use – reserved for future use.

Returns:

  • a boolean



1326
1327
1328
# File 'lib/models/user.rb', line 1326

def 
    return @is_resource_account
end

#is_resource_account=(value) ⇒ Object

Sets the isResourceAccount property value. Do not use – reserved for future use.

Parameters:

  • value

    Value to set for the isResourceAccount property.

Returns:

  • a void



1334
1335
1336
# File 'lib/models/user.rb', line 1334

def is_resource_account=(value)
    @is_resource_account = value
end

#job_titleObject

Gets the jobTitle property value. The user’s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1341
1342
1343
# File 'lib/models/user.rb', line 1341

def job_title
    return @job_title
end

#job_title=(value) ⇒ Object

Sets the jobTitle property value. The user’s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the jobTitle property.

Returns:

  • a void



1349
1350
1351
# File 'lib/models/user.rb', line 1349

def job_title=(value)
    @job_title = value
end

#joined_teamsObject

Gets the joinedTeams property value. The joinedTeams property

Returns:

  • a team



1356
1357
1358
# File 'lib/models/user.rb', line 1356

def joined_teams
    return @joined_teams
end

#joined_teams=(value) ⇒ Object

Sets the joinedTeams property value. The joinedTeams property

Parameters:

  • value

    Value to set for the joinedTeams property.

Returns:

  • a void



1364
1365
1366
# File 'lib/models/user.rb', line 1364

def joined_teams=(value)
    @joined_teams = value
end

#last_password_change_date_timeObject

Gets the lastPasswordChangeDateTime property value. The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.

Returns:

  • a date_time



1371
1372
1373
# File 'lib/models/user.rb', line 1371

def last_password_change_date_time
    return @last_password_change_date_time
end

#last_password_change_date_time=(value) ⇒ Object

Sets the lastPasswordChangeDateTime property value. The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.

Parameters:

  • value

    Value to set for the lastPasswordChangeDateTime property.

Returns:

  • a void



1379
1380
1381
# File 'lib/models/user.rb', line 1379

def last_password_change_date_time=(value)
    @last_password_change_date_time = value
end

Gets the legalAgeGroupClassification property value. Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select.

Returns:

  • a string



1386
1387
1388
# File 'lib/models/user.rb', line 1386

def legal_age_group_classification
    return @legal_age_group_classification
end

Sets the legalAgeGroupClassification property value. Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select.

Parameters:

  • value

    Value to set for the legalAgeGroupClassification property.

Returns:

  • a void



1394
1395
1396
# File 'lib/models/user.rb', line 1394

def legal_age_group_classification=(value)
    @legal_age_group_classification = value
end

#license_assignment_statesObject

Gets the licenseAssignmentStates property value. State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only. Returned only on $select.

Returns:

  • a license_assignment_state



1401
1402
1403
# File 'lib/models/user.rb', line 1401

def license_assignment_states
    return @license_assignment_states
end

#license_assignment_states=(value) ⇒ Object

Sets the licenseAssignmentStates property value. State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only. Returned only on $select.

Parameters:

  • value

    Value to set for the licenseAssignmentStates property.

Returns:

  • a void



1409
1410
1411
# File 'lib/models/user.rb', line 1409

def license_assignment_states=(value)
    @license_assignment_states = value
end

#license_detailsObject

Gets the licenseDetails property value. A collection of this user’s license details. Read-only.

Returns:

  • a license_details



1416
1417
1418
# File 'lib/models/user.rb', line 1416

def license_details
    return @license_details
end

#license_details=(value) ⇒ Object

Sets the licenseDetails property value. A collection of this user’s license details. Read-only.

Parameters:

  • value

    Value to set for the licenseDetails property.

Returns:

  • a void



1424
1425
1426
# File 'lib/models/user.rb', line 1424

def license_details=(value)
    @license_details = value
end

#mailObject

Gets the mail property value. The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user’s proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters. NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).

Returns:

  • a string



1431
1432
1433
# File 'lib/models/user.rb', line 1431

def mail
    return @mail
end

#mail=(value) ⇒ Object

Sets the mail property value. The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user’s proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters. NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).

Parameters:

  • value

    Value to set for the mail property.

Returns:

  • a void



1439
1440
1441
# File 'lib/models/user.rb', line 1439

def mail=(value)
    @mail = value
end

#mail_foldersObject

Gets the mailFolders property value. The user’s mail folders. Read-only. Nullable.

Returns:

  • a mail_folder



1446
1447
1448
# File 'lib/models/user.rb', line 1446

def mail_folders
    return @mail_folders
end

#mail_folders=(value) ⇒ Object

Sets the mailFolders property value. The user’s mail folders. Read-only. Nullable.

Parameters:

  • value

    Value to set for the mailFolders property.

Returns:

  • a void



1454
1455
1456
# File 'lib/models/user.rb', line 1454

def mail_folders=(value)
    @mail_folders = value
end

#mail_nicknameObject

Gets the mailNickname property value. The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1461
1462
1463
# File 'lib/models/user.rb', line 1461

def mail_nickname
    return @mail_nickname
end

#mail_nickname=(value) ⇒ Object

Sets the mailNickname property value. The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the mailNickname property.

Returns:

  • a void



1469
1470
1471
# File 'lib/models/user.rb', line 1469

def mail_nickname=(value)
    @mail_nickname = value
end

#mailbox_settingsObject

Gets the mailboxSettings property value. Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone. Returned only on $select.

Returns:

  • a mailbox_settings



1476
1477
1478
# File 'lib/models/user.rb', line 1476

def mailbox_settings
    return @mailbox_settings
end

#mailbox_settings=(value) ⇒ Object

Sets the mailboxSettings property value. Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone. Returned only on $select.

Parameters:

  • value

    Value to set for the mailboxSettings property.

Returns:

  • a void



1484
1485
1486
# File 'lib/models/user.rb', line 1484

def mailbox_settings=(value)
    @mailbox_settings = value
end

#managed_app_registrationsObject

Gets the managedAppRegistrations property value. Zero or more managed app registrations that belong to the user.

Returns:

  • a managed_app_registration



1491
1492
1493
# File 'lib/models/user.rb', line 1491

def managed_app_registrations
    return @managed_app_registrations
end

#managed_app_registrations=(value) ⇒ Object

Sets the managedAppRegistrations property value. Zero or more managed app registrations that belong to the user.

Parameters:

  • value

    Value to set for the managedAppRegistrations property.

Returns:

  • a void



1499
1500
1501
# File 'lib/models/user.rb', line 1499

def managed_app_registrations=(value)
    @managed_app_registrations = value
end

#managed_devicesObject

Gets the managedDevices property value. The managed devices associated with the user.

Returns:

  • a managed_device



1506
1507
1508
# File 'lib/models/user.rb', line 1506

def managed_devices
    return @managed_devices
end

#managed_devices=(value) ⇒ Object

Sets the managedDevices property value. The managed devices associated with the user.

Parameters:

  • value

    Value to set for the managedDevices property.

Returns:

  • a void



1514
1515
1516
# File 'lib/models/user.rb', line 1514

def managed_devices=(value)
    @managed_devices = value
end

#managerObject

Gets the manager property value. The user or contact that is this user’s manager. Read-only. (HTTP Methods: GET, PUT, DELETE.). Supports $expand.

Returns:

  • a directory_object



1521
1522
1523
# File 'lib/models/user.rb', line 1521

def manager
    return @manager
end

#manager=(value) ⇒ Object

Sets the manager property value. The user or contact that is this user’s manager. Read-only. (HTTP Methods: GET, PUT, DELETE.). Supports $expand.

Parameters:

  • value

    Value to set for the manager property.

Returns:

  • a void



1529
1530
1531
# File 'lib/models/user.rb', line 1529

def manager=(value)
    @manager = value
end

#member_ofObject

Gets the memberOf property value. The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.

Returns:

  • a directory_object



1536
1537
1538
# File 'lib/models/user.rb', line 1536

def member_of
    return @member_of
end

#member_of=(value) ⇒ Object

Sets the memberOf property value. The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.

Parameters:

  • value

    Value to set for the memberOf property.

Returns:

  • a void



1544
1545
1546
# File 'lib/models/user.rb', line 1544

def member_of=(value)
    @member_of = value
end

#messagesObject

Gets the messages property value. The messages in a mailbox or folder. Read-only. Nullable.

Returns:

  • a message



1551
1552
1553
# File 'lib/models/user.rb', line 1551

def messages
    return @messages
end

#messages=(value) ⇒ Object

Sets the messages property value. The messages in a mailbox or folder. Read-only. Nullable.

Parameters:

  • value

    Value to set for the messages property.

Returns:

  • a void



1559
1560
1561
# File 'lib/models/user.rb', line 1559

def messages=(value)
    @messages = value
end

#mobile_phoneObject

Gets the mobilePhone property value. The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.

Returns:

  • a string



1566
1567
1568
# File 'lib/models/user.rb', line 1566

def mobile_phone
    return @mobile_phone
end

#mobile_phone=(value) ⇒ Object

Sets the mobilePhone property value. The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.

Parameters:

  • value

    Value to set for the mobilePhone property.

Returns:

  • a void



1574
1575
1576
# File 'lib/models/user.rb', line 1574

def mobile_phone=(value)
    @mobile_phone = value
end

#my_siteObject

Gets the mySite property value. The URL for the user’s personal site. Returned only on $select.

Returns:

  • a string



1581
1582
1583
# File 'lib/models/user.rb', line 1581

def my_site
    return @my_site
end

#my_site=(value) ⇒ Object

Sets the mySite property value. The URL for the user’s personal site. Returned only on $select.

Parameters:

  • value

    Value to set for the mySite property.

Returns:

  • a void



1589
1590
1591
# File 'lib/models/user.rb', line 1589

def my_site=(value)
    @my_site = value
end

#oauth2_permission_grantsObject

Gets the oauth2PermissionGrants property value. The oauth2PermissionGrants property

Returns:

  • a o_auth2_permission_grant



1596
1597
1598
# File 'lib/models/user.rb', line 1596

def oauth2_permission_grants
    return @oauth2_permission_grants
end

#oauth2_permission_grants=(value) ⇒ Object

Sets the oauth2PermissionGrants property value. The oauth2PermissionGrants property

Parameters:

  • value

    Value to set for the oauth2PermissionGrants property.

Returns:

  • a void



1604
1605
1606
# File 'lib/models/user.rb', line 1604

def oauth2_permission_grants=(value)
    @oauth2_permission_grants = value
end

#office_locationObject

Gets the officeLocation property value. The office location in the user’s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1611
1612
1613
# File 'lib/models/user.rb', line 1611

def office_location
    return @office_location
end

#office_location=(value) ⇒ Object

Sets the officeLocation property value. The office location in the user’s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the officeLocation property.

Returns:

  • a void



1619
1620
1621
# File 'lib/models/user.rb', line 1619

def office_location=(value)
    @office_location = value
end

#on_premises_distinguished_nameObject

Gets the onPremisesDistinguishedName property value. Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.

Returns:

  • a string



1626
1627
1628
# File 'lib/models/user.rb', line 1626

def on_premises_distinguished_name
    return @on_premises_distinguished_name
end

#on_premises_distinguished_name=(value) ⇒ Object

Sets the onPremisesDistinguishedName property value. Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.

Parameters:

  • value

    Value to set for the onPremisesDistinguishedName property.

Returns:

  • a void



1634
1635
1636
# File 'lib/models/user.rb', line 1634

def on_premises_distinguished_name=(value)
    @on_premises_distinguished_name = value
end

#on_premises_domain_nameObject

Gets the onPremisesDomainName property value. Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.

Returns:

  • a string



1641
1642
1643
# File 'lib/models/user.rb', line 1641

def on_premises_domain_name
    return @on_premises_domain_name
end

#on_premises_domain_name=(value) ⇒ Object

Sets the onPremisesDomainName property value. Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.

Parameters:

  • value

    Value to set for the onPremisesDomainName property.

Returns:

  • a void



1649
1650
1651
# File 'lib/models/user.rb', line 1649

def on_premises_domain_name=(value)
    @on_premises_domain_name = value
end

#on_premises_extension_attributesObject

Gets the onPremisesExtensionAttributes property value. Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Returned only on $select. Supports $filter (eq, ne, not, in).

Returns:

  • a on_premises_extension_attributes



1656
1657
1658
# File 'lib/models/user.rb', line 1656

def on_premises_extension_attributes
    return @on_premises_extension_attributes
end

#on_premises_extension_attributes=(value) ⇒ Object

Sets the onPremisesExtensionAttributes property value. Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Returned only on $select. Supports $filter (eq, ne, not, in).

Parameters:

  • value

    Value to set for the onPremisesExtensionAttributes property.

Returns:

  • a void



1664
1665
1666
# File 'lib/models/user.rb', line 1664

def on_premises_extension_attributes=(value)
    @on_premises_extension_attributes = value
end

#on_premises_immutable_idObject

Gets the onPremisesImmutableId property value. This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user’s userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..

Returns:

  • a string



1671
1672
1673
# File 'lib/models/user.rb', line 1671

def on_premises_immutable_id
    return @on_premises_immutable_id
end

#on_premises_immutable_id=(value) ⇒ Object

Sets the onPremisesImmutableId property value. This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user’s userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..

Parameters:

  • value

    Value to set for the onPremisesImmutableId property.

Returns:

  • a void



1679
1680
1681
# File 'lib/models/user.rb', line 1679

def on_premises_immutable_id=(value)
    @on_premises_immutable_id = value
end

#on_premises_last_sync_date_timeObject

Gets the onPremisesLastSyncDateTime property value. Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).

Returns:

  • a date_time



1686
1687
1688
# File 'lib/models/user.rb', line 1686

def on_premises_last_sync_date_time
    return @on_premises_last_sync_date_time
end

#on_premises_last_sync_date_time=(value) ⇒ Object

Sets the onPremisesLastSyncDateTime property value. Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).

Parameters:

  • value

    Value to set for the onPremisesLastSyncDateTime property.

Returns:

  • a void



1694
1695
1696
# File 'lib/models/user.rb', line 1694

def on_premises_last_sync_date_time=(value)
    @on_premises_last_sync_date_time = value
end

#on_premises_provisioning_errorsObject

Gets the onPremisesProvisioningErrors property value. Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le).

Returns:

  • a on_premises_provisioning_error



1701
1702
1703
# File 'lib/models/user.rb', line 1701

def on_premises_provisioning_errors
    return @on_premises_provisioning_errors
end

#on_premises_provisioning_errors=(value) ⇒ Object

Sets the onPremisesProvisioningErrors property value. Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le).

Parameters:

  • value

    Value to set for the onPremisesProvisioningErrors property.

Returns:

  • a void



1709
1710
1711
# File 'lib/models/user.rb', line 1709

def on_premises_provisioning_errors=(value)
    @on_premises_provisioning_errors = value
end

#on_premises_sam_account_nameObject

Gets the onPremisesSamAccountName property value. Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).

Returns:

  • a string



1716
1717
1718
# File 'lib/models/user.rb', line 1716

def 
    return @on_premises_sam_account_name
end

#on_premises_sam_account_name=(value) ⇒ Object

Sets the onPremisesSamAccountName property value. Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).

Parameters:

  • value

    Value to set for the onPremisesSamAccountName property.

Returns:

  • a void



1724
1725
1726
# File 'lib/models/user.rb', line 1724

def (value)
    @on_premises_sam_account_name = value
end

#on_premises_security_identifierObject

Gets the onPremisesSecurityIdentifier property value. Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq including on null values).

Returns:

  • a string



1731
1732
1733
# File 'lib/models/user.rb', line 1731

def on_premises_security_identifier
    return @on_premises_security_identifier
end

#on_premises_security_identifier=(value) ⇒ Object

Sets the onPremisesSecurityIdentifier property value. Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq including on null values).

Parameters:

  • value

    Value to set for the onPremisesSecurityIdentifier property.

Returns:

  • a void



1739
1740
1741
# File 'lib/models/user.rb', line 1739

def on_premises_security_identifier=(value)
    @on_premises_security_identifier = value
end

#on_premises_sync_enabledObject

Gets the onPremisesSyncEnabled property value. true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn’t being synced and can be managed in Azure Active Directory (Azure AD). Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).

Returns:

  • a boolean



1746
1747
1748
# File 'lib/models/user.rb', line 1746

def on_premises_sync_enabled
    return @on_premises_sync_enabled
end

#on_premises_sync_enabled=(value) ⇒ Object

Sets the onPremisesSyncEnabled property value. true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn’t being synced and can be managed in Azure Active Directory (Azure AD). Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).

Parameters:

  • value

    Value to set for the onPremisesSyncEnabled property.

Returns:

  • a void



1754
1755
1756
# File 'lib/models/user.rb', line 1754

def on_premises_sync_enabled=(value)
    @on_premises_sync_enabled = value
end

#on_premises_user_principal_nameObject

Gets the onPremisesUserPrincipalName property value. Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).

Returns:

  • a string



1761
1762
1763
# File 'lib/models/user.rb', line 1761

def on_premises_user_principal_name
    return @on_premises_user_principal_name
end

#on_premises_user_principal_name=(value) ⇒ Object

Sets the onPremisesUserPrincipalName property value. Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).

Parameters:

  • value

    Value to set for the onPremisesUserPrincipalName property.

Returns:

  • a void



1769
1770
1771
# File 'lib/models/user.rb', line 1769

def on_premises_user_principal_name=(value)
    @on_premises_user_principal_name = value
end

#onenoteObject

Gets the onenote property value. The onenote property

Returns:

  • a onenote



1776
1777
1778
# File 'lib/models/user.rb', line 1776

def onenote
    return @onenote
end

#onenote=(value) ⇒ Object

Sets the onenote property value. The onenote property

Parameters:

  • value

    Value to set for the onenote property.

Returns:

  • a void



1784
1785
1786
# File 'lib/models/user.rb', line 1784

def onenote=(value)
    @onenote = value
end

#online_meetingsObject

Gets the onlineMeetings property value. Information about a meeting, including the URL used to join a meeting, the attendees’ list, and the description.

Returns:

  • a online_meeting



1791
1792
1793
# File 'lib/models/user.rb', line 1791

def online_meetings
    return @online_meetings
end

#online_meetings=(value) ⇒ Object

Sets the onlineMeetings property value. Information about a meeting, including the URL used to join a meeting, the attendees’ list, and the description.

Parameters:

  • value

    Value to set for the onlineMeetings property.

Returns:

  • a void



1799
1800
1801
# File 'lib/models/user.rb', line 1799

def online_meetings=(value)
    @online_meetings = value
end

#other_mailsObject

Gets the otherMails property value. A list of additional email addresses for the user; for example: [‘[email protected]’, ‘[email protected]’]. NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).

Returns:

  • a string



1806
1807
1808
# File 'lib/models/user.rb', line 1806

def other_mails
    return @other_mails
end

#other_mails=(value) ⇒ Object

Sets the otherMails property value. A list of additional email addresses for the user; for example: [‘[email protected]’, ‘[email protected]’]. NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).

Parameters:

  • value

    Value to set for the otherMails property.

Returns:

  • a void



1814
1815
1816
# File 'lib/models/user.rb', line 1814

def other_mails=(value)
    @other_mails = value
end

#outlookObject

Gets the outlook property value. The outlook property

Returns:

  • a outlook_user



1821
1822
1823
# File 'lib/models/user.rb', line 1821

def outlook
    return @outlook
end

#outlook=(value) ⇒ Object

Sets the outlook property value. The outlook property

Parameters:

  • value

    Value to set for the outlook property.

Returns:

  • a void



1829
1830
1831
# File 'lib/models/user.rb', line 1829

def outlook=(value)
    @outlook = value
end

#owned_devicesObject

Gets the ownedDevices property value. Devices that are owned by the user. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).

Returns:

  • a directory_object



1836
1837
1838
# File 'lib/models/user.rb', line 1836

def owned_devices
    return @owned_devices
end

#owned_devices=(value) ⇒ Object

Sets the ownedDevices property value. Devices that are owned by the user. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).

Parameters:

  • value

    Value to set for the ownedDevices property.

Returns:

  • a void



1844
1845
1846
# File 'lib/models/user.rb', line 1844

def owned_devices=(value)
    @owned_devices = value
end

#owned_objectsObject

Gets the ownedObjects property value. Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.

Returns:

  • a directory_object



1851
1852
1853
# File 'lib/models/user.rb', line 1851

def owned_objects
    return @owned_objects
end

#owned_objects=(value) ⇒ Object

Sets the ownedObjects property value. Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.

Parameters:

  • value

    Value to set for the ownedObjects property.

Returns:

  • a void



1859
1860
1861
# File 'lib/models/user.rb', line 1859

def owned_objects=(value)
    @owned_objects = value
end

#password_policiesObject

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 may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).

Returns:

  • a string



1866
1867
1868
# File 'lib/models/user.rb', line 1866

def password_policies
    return @password_policies
end

#password_policies=(value) ⇒ Object

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 may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).

Parameters:

  • value

    Value to set for the passwordPolicies property.

Returns:

  • a void



1874
1875
1876
# File 'lib/models/user.rb', line 1874

def password_policies=(value)
    @password_policies = value
end

#password_profileObject

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. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).

Returns:

  • a password_profile



1881
1882
1883
# File 'lib/models/user.rb', line 1881

def password_profile
    return @password_profile
end

#password_profile=(value) ⇒ Object

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. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).

Parameters:

  • value

    Value to set for the passwordProfile property.

Returns:

  • a void



1889
1890
1891
# File 'lib/models/user.rb', line 1889

def password_profile=(value)
    @password_profile = value
end

#past_projectsObject

Gets the pastProjects property value. A list for the user to enumerate their past projects. Returned only on $select.

Returns:

  • a string



1896
1897
1898
# File 'lib/models/user.rb', line 1896

def past_projects
    return @past_projects
end

#past_projects=(value) ⇒ Object

Sets the pastProjects property value. A list for the user to enumerate their past projects. Returned only on $select.

Parameters:

  • value

    Value to set for the pastProjects property.

Returns:

  • a void



1904
1905
1906
# File 'lib/models/user.rb', line 1904

def past_projects=(value)
    @past_projects = value
end

#peopleObject

Gets the people property value. People that are relevant to the user. Read-only. Nullable.

Returns:

  • a person



1911
1912
1913
# File 'lib/models/user.rb', line 1911

def people
    return @people
end

#people=(value) ⇒ Object

Sets the people property value. People that are relevant to the user. Read-only. Nullable.

Parameters:

  • value

    Value to set for the people property.

Returns:

  • a void



1919
1920
1921
# File 'lib/models/user.rb', line 1919

def people=(value)
    @people = value
end

#photoObject

Gets the photo property value. The user’s profile photo. Read-only.

Returns:

  • a profile_photo



1926
1927
1928
# File 'lib/models/user.rb', line 1926

def photo
    return @photo
end

#photo=(value) ⇒ Object

Sets the photo property value. The user’s profile photo. Read-only.

Parameters:

  • value

    Value to set for the photo property.

Returns:

  • a void



1934
1935
1936
# File 'lib/models/user.rb', line 1934

def photo=(value)
    @photo = value
end

#photosObject

Gets the photos property value. The photos property

Returns:

  • a profile_photo



1941
1942
1943
# File 'lib/models/user.rb', line 1941

def photos
    return @photos
end

#photos=(value) ⇒ Object

Sets the photos property value. The photos property

Parameters:

  • value

    Value to set for the photos property.

Returns:

  • a void



1949
1950
1951
# File 'lib/models/user.rb', line 1949

def photos=(value)
    @photos = value
end

#plannerObject

Gets the planner property value. Entry-point to the Planner resource that might exist for a user. Read-only.

Returns:

  • a planner_user



1956
1957
1958
# File 'lib/models/user.rb', line 1956

def planner
    return @planner
end

#planner=(value) ⇒ Object

Sets the planner property value. Entry-point to the Planner resource that might exist for a user. Read-only.

Parameters:

  • value

    Value to set for the planner property.

Returns:

  • a void



1964
1965
1966
# File 'lib/models/user.rb', line 1964

def planner=(value)
    @planner = value
end

#postal_codeObject

Gets the postalCode property value. The postal code for the user’s postal address. The postal code is specific to the user’s country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



1971
1972
1973
# File 'lib/models/user.rb', line 1971

def postal_code
    return @postal_code
end

#postal_code=(value) ⇒ Object

Sets the postalCode property value. The postal code for the user’s postal address. The postal code is specific to the user’s country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the postalCode property.

Returns:

  • a void



1979
1980
1981
# File 'lib/models/user.rb', line 1979

def postal_code=(value)
    @postal_code = value
end

#preferred_data_locationObject

Gets the preferredDataLocation property value. The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.

Returns:

  • a string



1986
1987
1988
# File 'lib/models/user.rb', line 1986

def preferred_data_location
    return @preferred_data_location
end

#preferred_data_location=(value) ⇒ Object

Sets the preferredDataLocation property value. The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.

Parameters:

  • value

    Value to set for the preferredDataLocation property.

Returns:

  • a void



1994
1995
1996
# File 'lib/models/user.rb', line 1994

def preferred_data_location=(value)
    @preferred_data_location = value
end

#preferred_languageObject

Gets the preferredLanguage property value. The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)

Returns:

  • a string



2001
2002
2003
# File 'lib/models/user.rb', line 2001

def preferred_language
    return @preferred_language
end

#preferred_language=(value) ⇒ Object

Sets the preferredLanguage property value. The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)

Parameters:

  • value

    Value to set for the preferredLanguage property.

Returns:

  • a void



2009
2010
2011
# File 'lib/models/user.rb', line 2009

def preferred_language=(value)
    @preferred_language = value
end

#preferred_nameObject

Gets the preferredName property value. The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.

Returns:

  • a string



2016
2017
2018
# File 'lib/models/user.rb', line 2016

def preferred_name
    return @preferred_name
end

#preferred_name=(value) ⇒ Object

Sets the preferredName property value. The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.

Parameters:

  • value

    Value to set for the preferredName property.

Returns:

  • a void



2024
2025
2026
# File 'lib/models/user.rb', line 2024

def preferred_name=(value)
    @preferred_name = value
end

#presenceObject

Gets the presence property value. The presence property

Returns:

  • a presence



2031
2032
2033
# File 'lib/models/user.rb', line 2031

def presence
    return @presence
end

#presence=(value) ⇒ Object

Sets the presence property value. The presence property

Parameters:

  • value

    Value to set for the presence property.

Returns:

  • a void



2039
2040
2041
# File 'lib/models/user.rb', line 2039

def presence=(value)
    @presence = value
end

Gets the print property value. The print property

Returns:

  • a user_print



2046
2047
2048
# File 'lib/models/user.rb', line 2046

def print
    return @print
end

#print=(value) ⇒ Object

Sets the print property value. The print property

Parameters:

  • value

    Value to set for the print property.

Returns:

  • a void



2054
2055
2056
# File 'lib/models/user.rb', line 2054

def print=(value)
    @print = value
end

#provisioned_plansObject

Gets the provisionedPlans property value. The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le).

Returns:

  • a provisioned_plan



2061
2062
2063
# File 'lib/models/user.rb', line 2061

def provisioned_plans
    return @provisioned_plans
end

#provisioned_plans=(value) ⇒ Object

Sets the provisionedPlans property value. The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le).

Parameters:

  • value

    Value to set for the provisionedPlans property.

Returns:

  • a void



2069
2070
2071
# File 'lib/models/user.rb', line 2069

def provisioned_plans=(value)
    @provisioned_plans = value
end

#proxy_addressesObject

Gets the proxyAddresses property value. For example: [‘SMTP: [email protected]’, ‘smtp: [email protected]’]. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).

Returns:

  • a string



2076
2077
2078
# File 'lib/models/user.rb', line 2076

def proxy_addresses
    return @proxy_addresses
end

#proxy_addresses=(value) ⇒ Object

Sets the proxyAddresses property value. For example: [‘SMTP: [email protected]’, ‘smtp: [email protected]’]. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).

Parameters:

  • value

    Value to set for the proxyAddresses property.

Returns:

  • a void



2084
2085
2086
# File 'lib/models/user.rb', line 2084

def proxy_addresses=(value)
    @proxy_addresses = value
end

#registered_devicesObject

Gets the registeredDevices property value. Devices that are registered for the user. Read-only. Nullable. Supports $expand.

Returns:

  • a directory_object



2091
2092
2093
# File 'lib/models/user.rb', line 2091

def registered_devices
    return @registered_devices
end

#registered_devices=(value) ⇒ Object

Sets the registeredDevices property value. Devices that are registered for the user. Read-only. Nullable. Supports $expand.

Parameters:

  • value

    Value to set for the registeredDevices property.

Returns:

  • a void



2099
2100
2101
# File 'lib/models/user.rb', line 2099

def registered_devices=(value)
    @registered_devices = value
end

#responsibilitiesObject

Gets the responsibilities property value. A list for the user to enumerate their responsibilities. Returned only on $select.

Returns:

  • a string



2106
2107
2108
# File 'lib/models/user.rb', line 2106

def responsibilities
    return @responsibilities
end

#responsibilities=(value) ⇒ Object

Sets the responsibilities property value. A list for the user to enumerate their responsibilities. Returned only on $select.

Parameters:

  • value

    Value to set for the responsibilities property.

Returns:

  • a void



2114
2115
2116
# File 'lib/models/user.rb', line 2114

def responsibilities=(value)
    @responsibilities = value
end

#schoolsObject

Gets the schools property value. A list for the user to enumerate the schools they have attended. Returned only on $select.

Returns:

  • a string



2121
2122
2123
# File 'lib/models/user.rb', line 2121

def schools
    return @schools
end

#schools=(value) ⇒ Object

Sets the schools property value. A list for the user to enumerate the schools they have attended. Returned only on $select.

Parameters:

  • value

    Value to set for the schools property.

Returns:

  • a void



2129
2130
2131
# File 'lib/models/user.rb', line 2129

def schools=(value)
    @schools = value
end

#scoped_role_member_ofObject

Gets the scopedRoleMemberOf property value. The scopedRoleMemberOf property

Returns:

  • a scoped_role_membership



2136
2137
2138
# File 'lib/models/user.rb', line 2136

def scoped_role_member_of
    return @scoped_role_member_of
end

#scoped_role_member_of=(value) ⇒ Object

Sets the scopedRoleMemberOf property value. The scopedRoleMemberOf property

Parameters:

  • value

    Value to set for the scopedRoleMemberOf property.

Returns:

  • a void



2144
2145
2146
# File 'lib/models/user.rb', line 2144

def scoped_role_member_of=(value)
    @scoped_role_member_of = value
end

#security_identifierObject

Gets the securityIdentifier property value. Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).

Returns:

  • a string



2151
2152
2153
# File 'lib/models/user.rb', line 2151

def security_identifier
    return @security_identifier
end

#security_identifier=(value) ⇒ Object

Sets the securityIdentifier property value. Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).

Parameters:

  • value

    Value to set for the securityIdentifier property.

Returns:

  • a void



2159
2160
2161
# File 'lib/models/user.rb', line 2159

def security_identifier=(value)
    @security_identifier = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
# File 'lib/models/user.rb', line 2167

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("aboutMe", @about_me)
    writer.write_boolean_value("accountEnabled", @account_enabled)
    writer.write_collection_of_object_values("activities", @activities)
    writer.write_string_value("ageGroup", @age_group)
    writer.write_collection_of_object_values("agreementAcceptances", @agreement_acceptances)
    writer.write_collection_of_object_values("appRoleAssignments", @app_role_assignments)
    writer.write_collection_of_object_values("assignedLicenses", @assigned_licenses)
    writer.write_collection_of_object_values("assignedPlans", @assigned_plans)
    writer.write_object_value("authentication", @authentication)
    writer.write_object_value("authorizationInfo", @authorization_info)
    writer.write_date_time_value("birthday", @birthday)
    writer.write_collection_of_primitive_values("businessPhones", @business_phones)
    writer.write_object_value("calendar", @calendar)
    writer.write_collection_of_object_values("calendarGroups", @calendar_groups)
    writer.write_collection_of_object_values("calendarView", @calendar_view)
    writer.write_collection_of_object_values("calendars", @calendars)
    writer.write_collection_of_object_values("chats", @chats)
    writer.write_string_value("city", @city)
    writer.write_string_value("companyName", @company_name)
    writer.write_string_value("consentProvidedForMinor", @consent_provided_for_minor)
    writer.write_collection_of_object_values("contactFolders", @contact_folders)
    writer.write_collection_of_object_values("contacts", @contacts)
    writer.write_string_value("country", @country)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_collection_of_object_values("createdObjects", @created_objects)
    writer.write_string_value("creationType", @creation_type)
    writer.write_object_value("customSecurityAttributes", @custom_security_attributes)
    writer.write_string_value("department", @department)
    writer.write_number_value("deviceEnrollmentLimit", @device_enrollment_limit)
    writer.write_collection_of_object_values("deviceManagementTroubleshootingEvents", @device_management_troubleshooting_events)
    writer.write_collection_of_object_values("directReports", @direct_reports)
    writer.write_string_value("displayName", @display_name)
    writer.write_object_value("drive", @drive)
    writer.write_collection_of_object_values("drives", @drives)
    writer.write_object_value("employeeExperience", @employee_experience)
    writer.write_date_time_value("employeeHireDate", @employee_hire_date)
    writer.write_string_value("employeeId", @employee_id)
    writer.write_date_time_value("employeeLeaveDateTime", @employee_leave_date_time)
    writer.write_object_value("employeeOrgData", @employee_org_data)
    writer.write_string_value("employeeType", @employee_type)
    writer.write_collection_of_object_values("events", @events)
    writer.write_collection_of_object_values("extensions", @extensions)
    writer.write_string_value("externalUserState", @external_user_state)
    writer.write_date_time_value("externalUserStateChangeDateTime", @external_user_state_change_date_time)
    writer.write_string_value("faxNumber", @fax_number)
    writer.write_collection_of_object_values("followedSites", @followed_sites)
    writer.write_string_value("givenName", @given_name)
    writer.write_date_time_value("hireDate", @hire_date)
    writer.write_collection_of_object_values("identities", @identities)
    writer.write_collection_of_primitive_values("imAddresses", @im_addresses)
    writer.write_object_value("inferenceClassification", @inference_classification)
    writer.write_object_value("insights", @insights)
    writer.write_collection_of_primitive_values("interests", @interests)
    writer.write_boolean_value("isResourceAccount", @is_resource_account)
    writer.write_string_value("jobTitle", @job_title)
    writer.write_collection_of_object_values("joinedTeams", @joined_teams)
    writer.write_date_time_value("lastPasswordChangeDateTime", @last_password_change_date_time)
    writer.write_string_value("legalAgeGroupClassification", @legal_age_group_classification)
    writer.write_collection_of_object_values("licenseAssignmentStates", @license_assignment_states)
    writer.write_collection_of_object_values("licenseDetails", @license_details)
    writer.write_string_value("mail", @mail)
    writer.write_collection_of_object_values("mailFolders", @mail_folders)
    writer.write_string_value("mailNickname", @mail_nickname)
    writer.write_object_value("mailboxSettings", @mailbox_settings)
    writer.write_collection_of_object_values("managedAppRegistrations", @managed_app_registrations)
    writer.write_collection_of_object_values("managedDevices", @managed_devices)
    writer.write_object_value("manager", @manager)
    writer.write_collection_of_object_values("memberOf", @member_of)
    writer.write_collection_of_object_values("messages", @messages)
    writer.write_string_value("mobilePhone", @mobile_phone)
    writer.write_string_value("mySite", @my_site)
    writer.write_collection_of_object_values("oauth2PermissionGrants", @oauth2_permission_grants)
    writer.write_string_value("officeLocation", @office_location)
    writer.write_string_value("onPremisesDistinguishedName", @on_premises_distinguished_name)
    writer.write_string_value("onPremisesDomainName", @on_premises_domain_name)
    writer.write_object_value("onPremisesExtensionAttributes", @on_premises_extension_attributes)
    writer.write_string_value("onPremisesImmutableId", @on_premises_immutable_id)
    writer.write_date_time_value("onPremisesLastSyncDateTime", @on_premises_last_sync_date_time)
    writer.write_collection_of_object_values("onPremisesProvisioningErrors", @on_premises_provisioning_errors)
    writer.write_string_value("onPremisesSamAccountName", @on_premises_sam_account_name)
    writer.write_string_value("onPremisesSecurityIdentifier", @on_premises_security_identifier)
    writer.write_boolean_value("onPremisesSyncEnabled", @on_premises_sync_enabled)
    writer.write_string_value("onPremisesUserPrincipalName", @on_premises_user_principal_name)
    writer.write_object_value("onenote", @onenote)
    writer.write_collection_of_object_values("onlineMeetings", @online_meetings)
    writer.write_collection_of_primitive_values("otherMails", @other_mails)
    writer.write_object_value("outlook", @outlook)
    writer.write_collection_of_object_values("ownedDevices", @owned_devices)
    writer.write_collection_of_object_values("ownedObjects", @owned_objects)
    writer.write_string_value("passwordPolicies", @password_policies)
    writer.write_object_value("passwordProfile", @password_profile)
    writer.write_collection_of_primitive_values("pastProjects", @past_projects)
    writer.write_collection_of_object_values("people", @people)
    writer.write_object_value("photo", @photo)
    writer.write_collection_of_object_values("photos", @photos)
    writer.write_object_value("planner", @planner)
    writer.write_string_value("postalCode", @postal_code)
    writer.write_string_value("preferredDataLocation", @preferred_data_location)
    writer.write_string_value("preferredLanguage", @preferred_language)
    writer.write_string_value("preferredName", @preferred_name)
    writer.write_object_value("presence", @presence)
    writer.write_object_value("print", @print)
    writer.write_collection_of_object_values("provisionedPlans", @provisioned_plans)
    writer.write_collection_of_primitive_values("proxyAddresses", @proxy_addresses)
    writer.write_collection_of_object_values("registeredDevices", @registered_devices)
    writer.write_collection_of_primitive_values("responsibilities", @responsibilities)
    writer.write_collection_of_primitive_values("schools", @schools)
    writer.write_collection_of_object_values("scopedRoleMemberOf", @scoped_role_member_of)
    writer.write_string_value("securityIdentifier", @security_identifier)
    writer.write_object_value("settings", @settings)
    writer.write_boolean_value("showInAddressList", @show_in_address_list)
    writer.write_object_value("signInActivity", @sign_in_activity)
    writer.write_date_time_value("signInSessionsValidFromDateTime", @sign_in_sessions_valid_from_date_time)
    writer.write_collection_of_primitive_values("skills", @skills)
    writer.write_string_value("state", @state)
    writer.write_string_value("streetAddress", @street_address)
    writer.write_string_value("surname", @surname)
    writer.write_object_value("teamwork", @teamwork)
    writer.write_object_value("todo", @todo)
    writer.write_collection_of_object_values("transitiveMemberOf", @transitive_member_of)
    writer.write_string_value("usageLocation", @usage_location)
    writer.write_string_value("userPrincipalName", @user_principal_name)
    writer.write_string_value("userType", @user_type)
end

#settingsObject

Gets the settings property value. The settings property

Returns:

  • a user_settings



2298
2299
2300
# File 'lib/models/user.rb', line 2298

def settings
    return @settings
end

#settings=(value) ⇒ Object

Sets the settings property value. The settings property

Parameters:

  • value

    Value to set for the settings property.

Returns:

  • a void



2306
2307
2308
# File 'lib/models/user.rb', line 2306

def settings=(value)
    @settings = value
end

#show_in_address_listObject

Gets the showInAddressList property value. Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.

Returns:

  • a boolean



2313
2314
2315
# File 'lib/models/user.rb', line 2313

def show_in_address_list
    return @show_in_address_list
end

#show_in_address_list=(value) ⇒ Object

Sets the showInAddressList property value. Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.

Parameters:

  • value

    Value to set for the showInAddressList property.

Returns:

  • a void



2321
2322
2323
# File 'lib/models/user.rb', line 2321

def show_in_address_list=(value)
    @show_in_address_list = value
end

#sign_in_activityObject

Gets the signInActivity property value. Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: Details for this property require an Azure AD Premium P1/P2 license and the AuditLog.Read.All permission.This property is not returned for a user who has never signed in or last signed in before April 2020.

Returns:

  • a sign_in_activity



2328
2329
2330
# File 'lib/models/user.rb', line 2328

def 
    return @sign_in_activity
end

#sign_in_activity=(value) ⇒ Object

Sets the signInActivity property value. Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: Details for this property require an Azure AD Premium P1/P2 license and the AuditLog.Read.All permission.This property is not returned for a user who has never signed in or last signed in before April 2020.

Parameters:

  • value

    Value to set for the signInActivity property.

Returns:

  • a void



2336
2337
2338
# File 'lib/models/user.rb', line 2336

def (value)
    @sign_in_activity = value
end

#sign_in_sessions_valid_from_date_timeObject

Gets the signInSessionsValidFromDateTime property value. Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will 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 will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select.

Returns:

  • a date_time



2343
2344
2345
# File 'lib/models/user.rb', line 2343

def 
    return @sign_in_sessions_valid_from_date_time
end

#sign_in_sessions_valid_from_date_time=(value) ⇒ Object

Sets the signInSessionsValidFromDateTime property value. Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will 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 will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select.

Parameters:

  • value

    Value to set for the signInSessionsValidFromDateTime property.

Returns:

  • a void



2351
2352
2353
# File 'lib/models/user.rb', line 2351

def (value)
    @sign_in_sessions_valid_from_date_time = value
end

#skillsObject

Gets the skills property value. A list for the user to enumerate their skills. Returned only on $select.

Returns:

  • a string



2358
2359
2360
# File 'lib/models/user.rb', line 2358

def skills
    return @skills
end

#skills=(value) ⇒ Object

Sets the skills property value. A list for the user to enumerate their skills. Returned only on $select.

Parameters:

  • value

    Value to set for the skills property.

Returns:

  • a void



2366
2367
2368
# File 'lib/models/user.rb', line 2366

def skills=(value)
    @skills = value
end

#stateObject

Gets the state property value. The state or province in the user’s address. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



2373
2374
2375
# File 'lib/models/user.rb', line 2373

def state
    return @state
end

#state=(value) ⇒ Object

Sets the state property value. The state or province in the user’s address. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the state property.

Returns:

  • a void



2381
2382
2383
# File 'lib/models/user.rb', line 2381

def state=(value)
    @state = value
end

#street_addressObject

Gets the streetAddress property value. The street address of the user’s place of business. Maximum length is 1024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



2388
2389
2390
# File 'lib/models/user.rb', line 2388

def street_address
    return @street_address
end

#street_address=(value) ⇒ Object

Sets the streetAddress property value. The street address of the user’s place of business. Maximum length is 1024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the streetAddress property.

Returns:

  • a void



2396
2397
2398
# File 'lib/models/user.rb', line 2396

def street_address=(value)
    @street_address = value
end

#surnameObject

Gets the surname property value. The user’s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



2403
2404
2405
# File 'lib/models/user.rb', line 2403

def surname
    return @surname
end

#surname=(value) ⇒ Object

Sets the surname property value. The user’s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the surname property.

Returns:

  • a void



2411
2412
2413
# File 'lib/models/user.rb', line 2411

def surname=(value)
    @surname = value
end

#teamworkObject

Gets the teamwork property value. A container for Microsoft Teams features available for the user. Read-only. Nullable.

Returns:

  • a user_teamwork



2418
2419
2420
# File 'lib/models/user.rb', line 2418

def teamwork
    return @teamwork
end

#teamwork=(value) ⇒ Object

Sets the teamwork property value. A container for Microsoft Teams features available for the user. Read-only. Nullable.

Parameters:

  • value

    Value to set for the teamwork property.

Returns:

  • a void



2426
2427
2428
# File 'lib/models/user.rb', line 2426

def teamwork=(value)
    @teamwork = value
end

#todoObject

Gets the todo property value. Represents the To Do services available to a user.

Returns:

  • a todo



2433
2434
2435
# File 'lib/models/user.rb', line 2433

def todo
    return @todo
end

#todo=(value) ⇒ Object

Sets the todo property value. Represents the To Do services available to a user.

Parameters:

  • value

    Value to set for the todo property.

Returns:

  • a void



2441
2442
2443
# File 'lib/models/user.rb', line 2441

def todo=(value)
    @todo = value
end

#transitive_member_ofObject

Gets the transitiveMemberOf property value. The groups, including nested groups, and directory roles that a user is a member of. Nullable.

Returns:

  • a directory_object



2448
2449
2450
# File 'lib/models/user.rb', line 2448

def transitive_member_of
    return @transitive_member_of
end

#transitive_member_of=(value) ⇒ Object

Sets the transitiveMemberOf property value. The groups, including nested groups, and directory roles that a user is a member of. Nullable.

Parameters:

  • value

    Value to set for the transitiveMemberOf property.

Returns:

  • a void



2456
2457
2458
# File 'lib/models/user.rb', line 2456

def transitive_member_of=(value)
    @transitive_member_of = value
end

#usage_locationObject

Gets the usageLocation property value. A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Returns:

  • a string



2463
2464
2465
# File 'lib/models/user.rb', line 2463

def usage_location
    return @usage_location
end

#usage_location=(value) ⇒ Object

Sets the usageLocation property value. A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

Parameters:

  • value

    Value to set for the usageLocation property.

Returns:

  • a void



2471
2472
2473
# File 'lib/models/user.rb', line 2471

def usage_location=(value)
    @usage_location = value
end

#user_principal_nameObject

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 organization.NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ‘ . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.

Returns:

  • a string



2478
2479
2480
# File 'lib/models/user.rb', line 2478

def user_principal_name
    return @user_principal_name
end

#user_principal_name=(value) ⇒ Object

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 organization.NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ‘ . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.

Parameters:

  • value

    Value to set for the userPrincipalName property.

Returns:

  • a void



2486
2487
2488
# File 'lib/models/user.rb', line 2486

def user_principal_name=(value)
    @user_principal_name = value
end

#user_typeObject

Gets the userType property value. A string value that can be used to classify user types in your directory, such as Member and Guest. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for member and guest users, see What are the default user permissions in Azure Active Directory?

Returns:

  • a string



2493
2494
2495
# File 'lib/models/user.rb', line 2493

def user_type
    return @user_type
end

#user_type=(value) ⇒ Object

Sets the userType property value. A string value that can be used to classify user types in your directory, such as Member and Guest. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for member and guest users, see What are the default user permissions in Azure Active Directory?

Parameters:

  • value

    Value to set for the userType property.

Returns:

  • a void



2501
2502
2503
# File 'lib/models/user.rb', line 2501

def user_type=(value)
    @user_type = value
end