Class: MicrosoftGraph::Models::ObjectIdentity

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/object_identity.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeObject

Instantiates a new objectIdentity and sets the default values.



43
44
45
# File 'lib/models/object_identity.rb', line 43

def initialize()
    @additional_data = Hash.new
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 object_identity

Raises:

  • (StandardError)


51
52
53
54
# File 'lib/models/object_identity.rb', line 51

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

Instance Method Details

#additional_dataObject

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



28
29
30
# File 'lib/models/object_identity.rb', line 28

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value

    Value to set for the additionalData property.

Returns:

  • a void



36
37
38
# File 'lib/models/object_identity.rb', line 36

def additional_data=(value)
    @additional_data = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



59
60
61
62
63
64
65
66
# File 'lib/models/object_identity.rb', line 59

def get_field_deserializers()
    return {
        "issuer" => lambda {|n| @issuer = n.get_string_value() },
        "issuerAssignedId" => lambda {|n| @issuer_assigned_id = n.get_string_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "signInType" => lambda {|n| @sign_in_type = n.get_string_value() },
    }
end

#issuerObject

Gets the issuer property value. Specifies the issuer of the identity, for example facebook.com.For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.Supports $filter. 512 character limit.

Returns:

  • a string



71
72
73
# File 'lib/models/object_identity.rb', line 71

def issuer
    return @issuer
end

#issuer=(value) ⇒ Object

Sets the issuer property value. Specifies the issuer of the identity, for example facebook.com.For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.Supports $filter. 512 character limit.

Parameters:

  • value

    Value to set for the issuer property.

Returns:

  • a void



79
80
81
# File 'lib/models/object_identity.rb', line 79

def issuer=(value)
    @issuer = value
end

#issuer_assigned_idObject

Gets the issuerAssignedId property value. Specifies the unique identifier assigned to the user by the issuer. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress, (or a custom string that starts with emailAddress like emailAddress1) issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or Supports $filter. 64 character limit.

Returns:

  • a string



86
87
88
# File 'lib/models/object_identity.rb', line 86

def issuer_assigned_id
    return @issuer_assigned_id
end

#issuer_assigned_id=(value) ⇒ Object

Sets the issuerAssignedId property value. Specifies the unique identifier assigned to the user by the issuer. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress, (or a custom string that starts with emailAddress like emailAddress1) issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or Supports $filter. 64 character limit.

Parameters:

  • value

    Value to set for the issuerAssignedId property.

Returns:

  • a void



94
95
96
# File 'lib/models/object_identity.rb', line 94

def issuer_assigned_id=(value)
    @issuer_assigned_id = value
end

#odata_typeObject

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



101
102
103
# File 'lib/models/object_identity.rb', line 101

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value

    Value to set for the @odata.type property.

Returns:

  • a void



109
110
111
# File 'lib/models/object_identity.rb', line 109

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


117
118
119
120
121
122
123
124
# File 'lib/models/object_identity.rb', line 117

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("issuer", @issuer)
    writer.write_string_value("issuerAssignedId", @issuer_assigned_id)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_string_value("signInType", @sign_in_type)
    writer.write_additional_data(@additional_data)
end

#sign_in_typeObject

Gets the signInType property value. Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity will update the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a userPrincipalName identity. Additional validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string.

Returns:

  • a string



129
130
131
# File 'lib/models/object_identity.rb', line 129

def 
    return @sign_in_type
end

#sign_in_type=(value) ⇒ Object

Sets the signInType property value. Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity will update the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a userPrincipalName identity. Additional validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string.

Parameters:

  • value

    Value to set for the signInType property.

Returns:

  • a void



137
138
139
# File 'lib/models/object_identity.rb', line 137

def (value)
    @sign_in_type = value
end