Class: MicrosoftGraph::Models::UserRegistrationDetails

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/user_registration_details.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

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

Constructor Details

#initialize ⇒ Object

Instantiates a new userRegistrationDetails and sets the default values.



59
60
61
 
# File 'lib/models/user_registration_details.rb', line 59

def initialize()
    super
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_registration_details

Raises:

  • (StandardError) 


67
68
69
70
 
# File 'lib/models/user_registration_details.rb', line 67

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

Instance Method Details

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/models/user_registration_details.rb', line 75

def get_field_deserializers()
    return super.merge({
        "isAdmin" => lambda {|n| @is_admin = n.get_boolean_value() },
        "isMfaCapable" => lambda {|n| @is_mfa_capable = n.get_boolean_value() },
        "isMfaRegistered" => lambda {|n| @is_mfa_registered = n.get_boolean_value() },
        "isPasswordlessCapable" => lambda {|n| @is_passwordless_capable = n.get_boolean_value() },
        "isSsprCapable" => lambda {|n| @is_sspr_capable = n.get_boolean_value() },
        "isSsprEnabled" => lambda {|n| @is_sspr_enabled = n.get_boolean_value() },
        "isSsprRegistered" => lambda {|n| @is_sspr_registered = n.get_boolean_value() },
        "isSystemPreferredAuthenticationMethodEnabled" => lambda {|n| @is_system_preferred_authentication_method_enabled = n.get_boolean_value() },
        "lastUpdatedDateTime" => lambda {|n| @last_updated_date_time = n.get_date_time_value() },
        "methodsRegistered" => lambda {|n| @methods_registered = n.get_collection_of_primitive_values(String) },
        "systemPreferredAuthenticationMethods" => lambda {|n| @system_preferred_authentication_methods = n.get_collection_of_primitive_values(String) },
        "userDisplayName" => lambda {|n| @user_display_name = n.get_string_value() },
        "userPreferredMethodForSecondaryAuthentication" => lambda {|n| @user_preferred_method_for_secondary_authentication = n.get_enum_value(MicrosoftGraph::Models::UserDefaultAuthenticationMethod) },
        "userPrincipalName" => lambda {|n| @user_principal_name = n.get_string_value() },
        "userType" => lambda {|n| @user_type = n.get_enum_value(MicrosoftGraph::Models::SignInUserType) },
    })
end

#is_admin ⇒ Object

Gets the isAdmin property value. Indicates whether the user has an admin role in the tenant. This value can be used to check the authentication methods that privileged accounts are registered for and capable of.

Returns:

  • a boolean



98
99
100
 
# File 'lib/models/user_registration_details.rb', line 98

def is_admin
    return @is_admin
end

#is_admin=(value) ⇒ Object

Sets the isAdmin property value. Indicates whether the user has an admin role in the tenant. This value can be used to check the authentication methods that privileged accounts are registered for and capable of.

Parameters:

  • value —

    Value to set for the isAdmin property.

Returns:

  • a void



106
107
108
 
# File 'lib/models/user_registration_details.rb', line 106

def is_admin=(value)
    @is_admin = value
end

#is_mfa_capable ⇒ Object

Gets the isMfaCapable property value. Indicates whether the user has registered a strong authentication method for multi-factor authentication. The method must be allowed by the authentication methods policy. Supports $filter (eq).

Returns:

  • a boolean



113
114
115
 
# File 'lib/models/user_registration_details.rb', line 113

def is_mfa_capable
    return @is_mfa_capable
end

#is_mfa_capable=(value) ⇒ Object

Sets the isMfaCapable property value. Indicates whether the user has registered a strong authentication method for multi-factor authentication. The method must be allowed by the authentication methods policy. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isMfaCapable property.

Returns:

  • a void



121
122
123
 
# File 'lib/models/user_registration_details.rb', line 121

def is_mfa_capable=(value)
    @is_mfa_capable = value
end

#is_mfa_registered ⇒ Object

Gets the isMfaRegistered property value. Indicates whether the user has registered a strong authentication method for multi-factor authentication. The method may not necessarily be allowed by the authentication methods policy. Supports $filter (eq).

Returns:

  • a boolean



128
129
130
 
# File 'lib/models/user_registration_details.rb', line 128

def is_mfa_registered
    return @is_mfa_registered
end

#is_mfa_registered=(value) ⇒ Object

Sets the isMfaRegistered property value. Indicates whether the user has registered a strong authentication method for multi-factor authentication. The method may not necessarily be allowed by the authentication methods policy. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isMfaRegistered property.

Returns:

  • a void



136
137
138
 
# File 'lib/models/user_registration_details.rb', line 136

def is_mfa_registered=(value)
    @is_mfa_registered = value
end

#is_passwordless_capable ⇒ Object

Gets the isPasswordlessCapable property value. Indicates whether the user has registered a passwordless strong authentication method (including FIDO2, Windows Hello for Business, and Microsoft Authenticator (Passwordless)) that is allowed by the authentication methods policy. Supports $filter (eq).

Returns:

  • a boolean



143
144
145
 
# File 'lib/models/user_registration_details.rb', line 143

def is_passwordless_capable
    return @is_passwordless_capable
end

#is_passwordless_capable=(value) ⇒ Object

Sets the isPasswordlessCapable property value. Indicates whether the user has registered a passwordless strong authentication method (including FIDO2, Windows Hello for Business, and Microsoft Authenticator (Passwordless)) that is allowed by the authentication methods policy. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isPasswordlessCapable property.

Returns:

  • a void



151
152
153
 
# File 'lib/models/user_registration_details.rb', line 151

def is_passwordless_capable=(value)
    @is_passwordless_capable = value
end

#is_sspr_capable ⇒ Object

Gets the isSsprCapable property value. Indicates whether the user has registered the required number of authentication methods for self-service password reset and the user is allowed to perform self-service password reset by policy. Supports $filter (eq).

Returns:

  • a boolean



158
159
160
 
# File 'lib/models/user_registration_details.rb', line 158

def is_sspr_capable
    return @is_sspr_capable
end

#is_sspr_capable=(value) ⇒ Object

Sets the isSsprCapable property value. Indicates whether the user has registered the required number of authentication methods for self-service password reset and the user is allowed to perform self-service password reset by policy. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isSsprCapable property.

Returns:

  • a void



166
167
168
 
# File 'lib/models/user_registration_details.rb', line 166

def is_sspr_capable=(value)
    @is_sspr_capable = value
end

#is_sspr_enabled ⇒ Object

Gets the isSsprEnabled property value. Indicates whether the user is allowed to perform self-service password reset by policy. The user may not necessarily have registered the required number of authentication methods for self-service password reset. Supports $filter (eq).

Returns:

  • a boolean



173
174
175
 
# File 'lib/models/user_registration_details.rb', line 173

def is_sspr_enabled
    return @is_sspr_enabled
end

#is_sspr_enabled=(value) ⇒ Object

Sets the isSsprEnabled property value. Indicates whether the user is allowed to perform self-service password reset by policy. The user may not necessarily have registered the required number of authentication methods for self-service password reset. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isSsprEnabled property.

Returns:

  • a void



181
182
183
 
# File 'lib/models/user_registration_details.rb', line 181

def is_sspr_enabled=(value)
    @is_sspr_enabled = value
end

#is_sspr_registered ⇒ Object

Gets the isSsprRegistered property value. Indicates whether the user has registered the required number of authentication methods for self-service password reset. The user may not necessarily be allowed to perform self-service password reset by policy. Supports $filter (eq).

Returns:

  • a boolean



188
189
190
 
# File 'lib/models/user_registration_details.rb', line 188

def is_sspr_registered
    return @is_sspr_registered
end

#is_sspr_registered=(value) ⇒ Object

Sets the isSsprRegistered property value. Indicates whether the user has registered the required number of authentication methods for self-service password reset. The user may not necessarily be allowed to perform self-service password reset by policy. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isSsprRegistered property.

Returns:

  • a void



196
197
198
 
# File 'lib/models/user_registration_details.rb', line 196

def is_sspr_registered=(value)
    @is_sspr_registered = value
end

#is_system_preferred_authentication_method_enabled ⇒ Object

Gets the isSystemPreferredAuthenticationMethodEnabled property value. Indicates whether system preferred authentication method is enabled. If enabled, the system dynamically determines the most secure authentication method among the methods registered by the user. Supports $filter (eq).

Returns:

  • a boolean



203
204
205
 
# File 'lib/models/user_registration_details.rb', line 203

def is_system_preferred_authentication_method_enabled
    return @is_system_preferred_authentication_method_enabled
end

#is_system_preferred_authentication_method_enabled=(value) ⇒ Object

Sets the isSystemPreferredAuthenticationMethodEnabled property value. Indicates whether system preferred authentication method is enabled. If enabled, the system dynamically determines the most secure authentication method among the methods registered by the user. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the isSystemPreferredAuthenticationMethodEnabled property.

Returns:

  • a void



211
212
213
 
# File 'lib/models/user_registration_details.rb', line 211

def is_system_preferred_authentication_method_enabled=(value)
    @is_system_preferred_authentication_method_enabled = value
end

#last_updated_date_time ⇒ Object

Gets the lastUpdatedDateTime property value. The date and time (UTC) when the record was last updated. The DateTimeOffset 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.

Returns:

  • a date_time



218
219
220
 
# File 'lib/models/user_registration_details.rb', line 218

def last_updated_date_time
    return @last_updated_date_time
end

#last_updated_date_time=(value) ⇒ Object

Sets the lastUpdatedDateTime property value. The date and time (UTC) when the record was last updated. The DateTimeOffset 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.

Parameters:

  • value —

    Value to set for the lastUpdatedDateTime property.

Returns:

  • a void



226
227
228
 
# File 'lib/models/user_registration_details.rb', line 226

def last_updated_date_time=(value)
    @last_updated_date_time = value
end

#methods_registered ⇒ Object

Gets the methodsRegistered property value. Collection of authentication methods registered, such as mobilePhone, email, fido2. Supports $filter (any with eq).

Returns:

  • a string



233
234
235
 
# File 'lib/models/user_registration_details.rb', line 233

def methods_registered
    return @methods_registered
end

#methods_registered=(value) ⇒ Object

Sets the methodsRegistered property value. Collection of authentication methods registered, such as mobilePhone, email, fido2. Supports $filter (any with eq).

Parameters:

  • value —

    Value to set for the methodsRegistered property.

Returns:

  • a void



241
242
243
 
# File 'lib/models/user_registration_details.rb', line 241

def methods_registered=(value)
    @methods_registered = 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) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/models/user_registration_details.rb', line 249

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_boolean_value("isAdmin", @is_admin)
    writer.write_boolean_value("isMfaCapable", @is_mfa_capable)
    writer.write_boolean_value("isMfaRegistered", @is_mfa_registered)
    writer.write_boolean_value("isPasswordlessCapable", @is_passwordless_capable)
    writer.write_boolean_value("isSsprCapable", @is_sspr_capable)
    writer.write_boolean_value("isSsprEnabled", @is_sspr_enabled)
    writer.write_boolean_value("isSsprRegistered", @is_sspr_registered)
    writer.write_boolean_value("isSystemPreferredAuthenticationMethodEnabled", @is_system_preferred_authentication_method_enabled)
    writer.write_date_time_value("lastUpdatedDateTime", @last_updated_date_time)
    writer.write_collection_of_primitive_values("methodsRegistered", @methods_registered)
    writer.write_collection_of_primitive_values("systemPreferredAuthenticationMethods", @system_preferred_authentication_methods)
    writer.write_string_value("userDisplayName", @user_display_name)
    writer.write_enum_value("userPreferredMethodForSecondaryAuthentication", @user_preferred_method_for_secondary_authentication)
    writer.write_string_value("userPrincipalName", @user_principal_name)
    writer.write_enum_value("userType", @user_type)
end

#system_preferred_authentication_methods ⇒ Object

Gets the systemPreferredAuthenticationMethods property value. Collection of authentication methods that the system determined to be the most secure authentication methods among the registered methods for second factor authentication. Possible values are: push, oath, voiceMobile, voiceAlternateMobile, voiceOffice, sms, none, unknownFutureValue. Supports $filter (any with eq).

Returns:

  • a string



272
273
274
 
# File 'lib/models/user_registration_details.rb', line 272

def system_preferred_authentication_methods
    return @system_preferred_authentication_methods
end

#system_preferred_authentication_methods=(value) ⇒ Object

Sets the systemPreferredAuthenticationMethods property value. Collection of authentication methods that the system determined to be the most secure authentication methods among the registered methods for second factor authentication. Possible values are: push, oath, voiceMobile, voiceAlternateMobile, voiceOffice, sms, none, unknownFutureValue. Supports $filter (any with eq).

Parameters:

  • value —

    Value to set for the systemPreferredAuthenticationMethods property.

Returns:

  • a void



280
281
282
 
# File 'lib/models/user_registration_details.rb', line 280

def system_preferred_authentication_methods=(value)
    @system_preferred_authentication_methods = value
end

#user_display_name ⇒ Object

Gets the userDisplayName property value. The user display name, such as Adele Vance. Supports $filter (eq, startsWith) and $orderBy.

Returns:

  • a string



287
288
289
 
# File 'lib/models/user_registration_details.rb', line 287

def user_display_name
    return @user_display_name
end

#user_display_name=(value) ⇒ Object

Sets the userDisplayName property value. The user display name, such as Adele Vance. Supports $filter (eq, startsWith) and $orderBy.

Parameters:

  • value —

    Value to set for the userDisplayName property.

Returns:

  • a void



295
296
297
 
# File 'lib/models/user_registration_details.rb', line 295

def user_display_name=(value)
    @user_display_name = value
end

#user_preferred_method_for_secondary_authentication ⇒ Object

Gets the userPreferredMethodForSecondaryAuthentication property value. The method the user selected as the default second-factor for performing multi-factor authentication. Possible values are: push, oath, voiceMobile, voiceAlternateMobile, voiceOffice, sms, none, unknownFutureValue. This property is used as preferred MFA method when isSystemPreferredAuthenticationMethodEnabled is false. Supports $filter (any with eq).

Returns:

  • a user_default_authentication_method



302
303
304
 
# File 'lib/models/user_registration_details.rb', line 302

def user_preferred_method_for_secondary_authentication
    return @user_preferred_method_for_secondary_authentication
end

#user_preferred_method_for_secondary_authentication=(value) ⇒ Object

Sets the userPreferredMethodForSecondaryAuthentication property value. The method the user selected as the default second-factor for performing multi-factor authentication. Possible values are: push, oath, voiceMobile, voiceAlternateMobile, voiceOffice, sms, none, unknownFutureValue. This property is used as preferred MFA method when isSystemPreferredAuthenticationMethodEnabled is false. Supports $filter (any with eq).

Parameters:

  • value —

    Value to set for the userPreferredMethodForSecondaryAuthentication property.

Returns:

  • a void



310
311
312
 
# File 'lib/models/user_registration_details.rb', line 310

def user_preferred_method_for_secondary_authentication=(value)
    @user_preferred_method_for_secondary_authentication = value
end

#user_principal_name ⇒ Object

Gets the userPrincipalName property value. The user principal name, such as [email protected]. Supports $filter (eq, startsWith) and $orderBy.

Returns:

  • a string



317
318
319
 
# File 'lib/models/user_registration_details.rb', line 317

def user_principal_name
    return @user_principal_name
end

#user_principal_name=(value) ⇒ Object

Sets the userPrincipalName property value. The user principal name, such as [email protected]. Supports $filter (eq, startsWith) and $orderBy.

Parameters:

  • value —

    Value to set for the userPrincipalName property.

Returns:

  • a void



325
326
327
 
# File 'lib/models/user_registration_details.rb', line 325

def user_principal_name=(value)
    @user_principal_name = value
end

#user_type ⇒ Object

Gets the userType property value. Identifies whether the user is a member or guest in the tenant. The possible values are: member, guest, unknownFutureValue.

Returns:

  • a sign_in_user_type



332
333
334
 
# File 'lib/models/user_registration_details.rb', line 332

def user_type
    return @user_type
end

#user_type=(value) ⇒ Object

Sets the userType property value. Identifies whether the user is a member or guest in the tenant. The possible values are: member, guest, unknownFutureValue.

Parameters:

  • value —

    Value to set for the userType property.

Returns:

  • a void



340
341
342
 
# File 'lib/models/user_registration_details.rb', line 340

def user_type=(value)
    @user_type = value
end