Class: MicrosoftGraph::Models::SamlOrWsFedProvider

Inherits:
IdentityProviderBase show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/saml_or_ws_fed_provider.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IdentityProviderBase

#display_name, #display_name=

Methods inherited from Entity

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

Constructor Details

#initialize ⇒ Object

Instantiates a new samlOrWsFedProvider and sets the default values.



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

def initialize()
    super
    @odata_type = "#microsoft.graph.samlOrWsFedProvider"
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 saml_or_ws_fed_provider

Raises:

  • (StandardError) 


37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 37

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    mapping_value_node = parse_node.get_child_node("@odata.type")
    unless mapping_value_node.nil? then
        mapping_value = mapping_value_node.get_string_value
        case mapping_value
            when "#microsoft.graph.internalDomainFederation"
                return InternalDomainFederation.new
            when "#microsoft.graph.samlOrWsFedExternalDomainFederation"
                return SamlOrWsFedExternalDomainFederation.new
        end
    end
    return SamlOrWsFedProvider.new
end

Instance Method Details

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



55
56
57
58
59
60
61
62
63
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 55

def get_field_deserializers()
    return super.merge({
        "issuerUri" => lambda {|n| @issuer_uri = n.get_string_value() },
        "metadataExchangeUri" => lambda {|n| @metadata_exchange_uri = n.get_string_value() },
        "passiveSignInUri" => lambda {|n| @passive_sign_in_uri = n.get_string_value() },
        "preferredAuthenticationProtocol" => lambda {|n| @preferred_authentication_protocol = n.get_enum_value(MicrosoftGraph::Models::AuthenticationProtocol) },
        "signingCertificate" => lambda {|n| @signing_certificate = n.get_string_value() },
    })
end

#issuer_uri ⇒ Object

Gets the issuerUri property value. Issuer URI of the federation server.

Returns:

  • a string



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

def issuer_uri
    return @issuer_uri
end

#issuer_uri=(value) ⇒ Object

Sets the issuerUri property value. Issuer URI of the federation server.

Parameters:

  • value —

    Value to set for the issuerUri property.

Returns:

  • a void



76
77
78
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 76

def issuer_uri=(value)
    @issuer_uri = value
end

#metadata_exchange_uri ⇒ Object

Gets the metadataExchangeUri property value. URI of the metadata exchange endpoint used for authentication from rich client applications.

Returns:

  • a string



83
84
85
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 83

def metadata_exchange_uri
    return @metadata_exchange_uri
end

#metadata_exchange_uri=(value) ⇒ Object

Sets the metadataExchangeUri property value. URI of the metadata exchange endpoint used for authentication from rich client applications.

Parameters:

  • value —

    Value to set for the metadataExchangeUri property.

Returns:

  • a void



91
92
93
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 91

def metadata_exchange_uri=(value)
    @metadata_exchange_uri = value
end

#passive_sign_in_uri ⇒ Object

Gets the passiveSignInUri property value. URI that web-based clients are directed to when signing in to Azure Active Directory (Azure AD) services.

Returns:

  • a string



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

def 
    return @passive_sign_in_uri
end

#passive_sign_in_uri=(value) ⇒ Object

Sets the passiveSignInUri property value. URI that web-based clients are directed to when signing in to Azure Active Directory (Azure AD) services.

Parameters:

  • value —

    Value to set for the passiveSignInUri property.

Returns:

  • a void



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

def (value)
    @passive_sign_in_uri = value
end

#preferred_authentication_protocol ⇒ Object

Gets the preferredAuthenticationProtocol property value. Preferred authentication protocol. The possible values are: wsFed, saml, unknownFutureValue.

Returns:

  • a authentication_protocol



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

def preferred_authentication_protocol
    return @preferred_authentication_protocol
end

#preferred_authentication_protocol=(value) ⇒ Object

Sets the preferredAuthenticationProtocol property value. Preferred authentication protocol. The possible values are: wsFed, saml, unknownFutureValue.

Parameters:

  • value —

    Value to set for the preferredAuthenticationProtocol property.

Returns:

  • a void



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

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


129
130
131
132
133
134
135
136
137
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 129

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("issuerUri", @issuer_uri)
    writer.write_string_value("metadataExchangeUri", @metadata_exchange_uri)
    writer.write_string_value("passiveSignInUri", @passive_sign_in_uri)
    writer.write_enum_value("preferredAuthenticationProtocol", @preferred_authentication_protocol)
    writer.write_string_value("signingCertificate", @signing_certificate)
end

#signing_certificate ⇒ Object

Gets the signingCertificate property value. Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP’s token signing certificate and must be compatible with the X509Certificate2 class. This property is used in the following scenarios: if a rollover is required outside of the autorollover update a new federation service is being set up if the new token signing certificate isn’t present in the federation properties after the federation service certificate has been updated. Azure AD updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn’t available, Azure AD monitors the metadata daily and will update the federation settings for the domain when a new certificate is available.

Returns:

  • a string



142
143
144
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 142

def signing_certificate
    return @signing_certificate
end

#signing_certificate=(value) ⇒ Object

Sets the signingCertificate property value. Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP’s token signing certificate and must be compatible with the X509Certificate2 class. This property is used in the following scenarios: if a rollover is required outside of the autorollover update a new federation service is being set up if the new token signing certificate isn’t present in the federation properties after the federation service certificate has been updated. Azure AD updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn’t available, Azure AD monitors the metadata daily and will update the federation settings for the domain when a new certificate is available.

Parameters:

  • value —

    Value to set for the signingCertificate property.

Returns:

  • a void



150
151
152
 
# File 'lib/models/saml_or_ws_fed_provider.rb', line 150

def signing_certificate=(value)
    @signing_certificate = value
end