Class: MicrosoftGraph::Models::InternalDomainFederation

Inherits:
SamlOrWsFedProvider show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/internal_domain_federation.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SamlOrWsFedProvider

#issuer_uri, #issuer_uri=, #metadata_exchange_uri, #metadata_exchange_uri=, #passive_sign_in_uri, #passive_sign_in_uri=, #preferred_authentication_protocol, #preferred_authentication_protocol=, #signing_certificate, #signing_certificate=

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 internalDomainFederation and sets the default values.



49
50
51
52
 
# File 'lib/models/internal_domain_federation.rb', line 49

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

Raises:

  • (StandardError) 


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

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

Instance Method Details

#active_sign_in_uri ⇒ Object

Gets the activeSignInUri property value. URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Azure Active Directory (Azure AD). Corresponds to the ActiveLogOnUri property of the Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.

Returns:

  • a string



34
35
36
 
# File 'lib/models/internal_domain_federation.rb', line 34

def 
    return 
end

#active_sign_in_uri=(value) ⇒ Object

Sets the activeSignInUri property value. URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Azure Active Directory (Azure AD). Corresponds to the ActiveLogOnUri property of the Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.

Parameters:

  • value —

    Value to set for the activeSignInUri property.

Returns:

  • a void



42
43
44
 
# File 'lib/models/internal_domain_federation.rb', line 42

def (value)
     = value
end

#federated_idp_mfa_behavior ⇒ Object

Gets the federatedIdpMfaBehavior property value. Determines whether Azure AD accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: acceptIfMfaDoneByFederatedIdp, enforceMfaByFederatedIdp, rejectMfaByFederatedIdp, unknownFutureValue. For more information, see federatedIdpMfaBehavior values.

Returns:

  • a federated_idp_mfa_behavior



66
67
68
 
# File 'lib/models/internal_domain_federation.rb', line 66

def federated_idp_mfa_behavior
    return @federated_idp_mfa_behavior
end

#federated_idp_mfa_behavior=(value) ⇒ Object

Sets the federatedIdpMfaBehavior property value. Determines whether Azure AD accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: acceptIfMfaDoneByFederatedIdp, enforceMfaByFederatedIdp, rejectMfaByFederatedIdp, unknownFutureValue. For more information, see federatedIdpMfaBehavior values.

Parameters:

  • value —

    Value to set for the federatedIdpMfaBehavior property.

Returns:

  • a void



74
75
76
 
# File 'lib/models/internal_domain_federation.rb', line 74

def federated_idp_mfa_behavior=(value)
    @federated_idp_mfa_behavior = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/models/internal_domain_federation.rb', line 81

def get_field_deserializers()
    return super.merge({
        "activeSignInUri" => lambda {|n|  = n.get_string_value() },
        "federatedIdpMfaBehavior" => lambda {|n| @federated_idp_mfa_behavior = n.get_enum_value(MicrosoftGraph::Models::FederatedIdpMfaBehavior) },
        "isSignedAuthenticationRequestRequired" => lambda {|n| @is_signed_authentication_request_required = n.get_boolean_value() },
        "nextSigningCertificate" => lambda {|n| @next_signing_certificate = n.get_string_value() },
        "promptLoginBehavior" => lambda {|n|  = n.get_enum_value(MicrosoftGraph::Models::PromptLoginBehavior) },
        "signOutUri" => lambda {|n| @sign_out_uri = n.get_string_value() },
        "signingCertificateUpdateStatus" => lambda {|n| @signing_certificate_update_status = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SigningCertificateUpdateStatus.create_from_discriminator_value(pn) }) },
    })
end

#is_signed_authentication_request_required ⇒ Object

Gets the isSignedAuthenticationRequestRequired property value. If true, when SAML authentication requests are sent to the federated SAML IdP, Azure AD will sign those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IdP are not signed.

Returns:

  • a boolean



96
97
98
 
# File 'lib/models/internal_domain_federation.rb', line 96

def is_signed_authentication_request_required
    return @is_signed_authentication_request_required
end

#is_signed_authentication_request_required=(value) ⇒ Object

Sets the isSignedAuthenticationRequestRequired property value. If true, when SAML authentication requests are sent to the federated SAML IdP, Azure AD will sign those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IdP are not signed.

Parameters:

  • value —

    Value to set for the isSignedAuthenticationRequestRequired property.

Returns:

  • a void



104
105
106
 
# File 'lib/models/internal_domain_federation.rb', line 104

def is_signed_authentication_request_required=(value)
    @is_signed_authentication_request_required = value
end

#next_signing_certificate ⇒ Object

Gets the nextSigningCertificate property value. Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP’s token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the signingCertificate, the nextSigningCertificate property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate is not present in the federation properties after the federation service certificate has been updated.

Returns:

  • a string



111
112
113
 
# File 'lib/models/internal_domain_federation.rb', line 111

def next_signing_certificate
    return @next_signing_certificate
end

#next_signing_certificate=(value) ⇒ Object

Sets the nextSigningCertificate property value. Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP’s token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the signingCertificate, the nextSigningCertificate property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate is not present in the federation properties after the federation service certificate has been updated.

Parameters:

  • value —

    Value to set for the nextSigningCertificate property.

Returns:

  • a void



119
120
121
 
# File 'lib/models/internal_domain_federation.rb', line 119

def next_signing_certificate=(value)
    @next_signing_certificate = value
end

#prompt_login_behavior ⇒ Object

Gets the promptLoginBehavior property value. Sets the preferred behavior for the sign-in prompt. The possible values are: translateToFreshPasswordAuthentication, nativeSupport, disabled, unknownFutureValue.

Returns:

  • a prompt_login_behavior



126
127
128
 
# File 'lib/models/internal_domain_federation.rb', line 126

def 
    return 
end

#prompt_login_behavior=(value) ⇒ Object

Sets the promptLoginBehavior property value. Sets the preferred behavior for the sign-in prompt. The possible values are: translateToFreshPasswordAuthentication, nativeSupport, disabled, unknownFutureValue.

Parameters:

  • value —

    Value to set for the promptLoginBehavior property.

Returns:

  • a void



134
135
136
 
# File 'lib/models/internal_domain_federation.rb', line 134

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


142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/models/internal_domain_federation.rb', line 142

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("activeSignInUri", )
    writer.write_enum_value("federatedIdpMfaBehavior", @federated_idp_mfa_behavior)
    writer.write_boolean_value("isSignedAuthenticationRequestRequired", @is_signed_authentication_request_required)
    writer.write_string_value("nextSigningCertificate", @next_signing_certificate)
    writer.write_enum_value("promptLoginBehavior", )
    writer.write_string_value("signOutUri", @sign_out_uri)
    writer.write_object_value("signingCertificateUpdateStatus", @signing_certificate_update_status)
end

#sign_out_uri ⇒ Object

Gets the signOutUri property value. URI that clients are redirected to when they sign out of Azure AD services. Corresponds to the LogOffUri property of the Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.

Returns:

  • a string



157
158
159
 
# File 'lib/models/internal_domain_federation.rb', line 157

def sign_out_uri
    return @sign_out_uri
end

#sign_out_uri=(value) ⇒ Object

Sets the signOutUri property value. URI that clients are redirected to when they sign out of Azure AD services. Corresponds to the LogOffUri property of the Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet.

Parameters:

  • value —

    Value to set for the signOutUri property.

Returns:

  • a void



165
166
167
 
# File 'lib/models/internal_domain_federation.rb', line 165

def sign_out_uri=(value)
    @sign_out_uri = value
end

#signing_certificate_update_status ⇒ Object

Gets the signingCertificateUpdateStatus property value. Provides status and timestamp of the last update of the signing certificate.

Returns:

  • a signing_certificate_update_status



172
173
174
 
# File 'lib/models/internal_domain_federation.rb', line 172

def signing_certificate_update_status
    return @signing_certificate_update_status
end

#signing_certificate_update_status=(value) ⇒ Object

Sets the signingCertificateUpdateStatus property value. Provides status and timestamp of the last update of the signing certificate.

Parameters:

  • value —

    Value to set for the signingCertificateUpdateStatus property.

Returns:

  • a void



180
181
182
 
# File 'lib/models/internal_domain_federation.rb', line 180

def signing_certificate_update_status=(value)
    @signing_certificate_update_status = value
end