Class: OCI::Identity::Models::Saml2IdentityProvider

Inherits:
IdentityProvider show all
Defined in:
lib/oci/identity/models/saml2_identity_provider.rb

Overview

A special type of IdentityProvider that supports the SAML 2.0 protocol. For more information, see [Identity Providers and Federation](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).

Constant Summary

Constants inherited from IdentityProvider

IdentityProvider::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IdentityProvider

#compartment_id, #defined_tags, #description, #freeform_tags, #id, #inactive_status, #lifecycle_state, #name, #product_type, #protocol, #time_created

Instance Method Summary collapse

Methods inherited from IdentityProvider

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ Saml2IdentityProvider

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :name (String) —

    The value to assign to the #name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :product_type (String) —

    The value to assign to the #product_type proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :inactive_status (Integer) —

    The value to assign to the #inactive_status proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :metadata_url (String) —

    The value to assign to the #metadata_url property

  • :signing_certificate (String) —

    The value to assign to the #signing_certificate property

  • :redirect_url (String) —

    The value to assign to the #redirect_url property



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 46

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['protocol'] = 'SAML2'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes[:'metadataUrl']
    self.metadata_url = attributes[:'metadataUrl']
  end

  raise 'You cannot provide both :metadataUrl and :metadata_url' if attributes.key?(:'metadataUrl') && attributes.key?(:'metadata_url')

  if attributes[:'metadata_url']
    self.metadata_url = attributes[:'metadata_url']
  end

  if attributes[:'signingCertificate']
    self.signing_certificate = attributes[:'signingCertificate']
  end

  raise 'You cannot provide both :signingCertificate and :signing_certificate' if attributes.key?(:'signingCertificate') && attributes.key?(:'signing_certificate')

  if attributes[:'signing_certificate']
    self.signing_certificate = attributes[:'signing_certificate']
  end

  if attributes[:'redirectUrl']
    self.redirect_url = attributes[:'redirectUrl']
  end

  raise 'You cannot provide both :redirectUrl and :redirect_url' if attributes.key?(:'redirectUrl') && attributes.key?(:'redirect_url')

  if attributes[:'redirect_url']
    self.redirect_url = attributes[:'redirect_url']
  end

end

Instance Attribute Details

#metadata_url ⇒ String

[Required] The URL for retrieving the identity provider’s metadata, which contains information required for federating.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 16

def metadata_url
  @metadata_url
end

#redirect_url ⇒ String

[Required] The URL to redirect federated users to for authentication with the identity provider.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 28

def redirect_url
  @redirect_url
end

#signing_certificate ⇒ String

[Required] The identity provider’s signing certificate used by the IAM Service to validate the SAML2 token.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 22

def signing_certificate
  @signing_certificate
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 90

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      description == other_object.description &&
      product_type == other_object.product_type &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status &&
      protocol == other_object.protocol &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags &&
      metadata_url == other_object.metadata_url &&
      signing_certificate == other_object.signing_certificate &&
      redirect_url == other_object.redirect_url
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 124

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


111
112
113
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 111

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 117

def hash
  [id, compartment_id, name, description, product_type, time_created, lifecycle_state, inactive_status, protocol, freeform_tags, defined_tags, metadata_url, signing_certificate, redirect_url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 149

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



143
144
145
 
# File 'lib/oci/identity/models/saml2_identity_provider.rb', line 143

def to_s
  to_hash.to_s
end