Class: OryClient::OnboardingPortalOrganization

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/onboarding_portal_organization.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OnboardingPortalOrganization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::OnboardingPortalOrganization` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::OnboardingPortalOrganization`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'base_url')
    self.base_url = attributes[:'base_url']
  else
    self.base_url = nil
  end

  if attributes.key?(:'kratos_selfservice_methods_oidc_config_providers')
    if (value = attributes[:'kratos_selfservice_methods_oidc_config_providers']).is_a?(Array)
      self.kratos_selfservice_methods_oidc_config_providers = value
    end
  else
    self.kratos_selfservice_methods_oidc_config_providers = nil
  end

  if attributes.key?(:'kratos_selfservice_methods_saml_config_providers')
    if (value = attributes[:'kratos_selfservice_methods_saml_config_providers']).is_a?(Array)
      self.kratos_selfservice_methods_saml_config_providers = value
    end
  else
    self.kratos_selfservice_methods_saml_config_providers = nil
  end

  if attributes.key?(:'organization_id')
    self.organization_id = attributes[:'organization_id']
  else
    self.organization_id = nil
  end

  if attributes.key?(:'organization_label')
    self.organization_label = attributes[:'organization_label']
  end

  if attributes.key?(:'proxy_acs_url')
    self.proxy_acs_url = attributes[:'proxy_acs_url']
  end

  if attributes.key?(:'proxy_oidc_redirect_url')
    self.proxy_oidc_redirect_url = attributes[:'proxy_oidc_redirect_url']
  end

  if attributes.key?(:'proxy_saml_audience_override')
    self.proxy_saml_audience_override = attributes[:'proxy_saml_audience_override']
  end

  if attributes.key?(:'proxy_scim_server_url')
    self.proxy_scim_server_url = attributes[:'proxy_scim_server_url']
  end

  if attributes.key?(:'revision_id')
    self.revision_id = attributes[:'revision_id']
  else
    self.revision_id = nil
  end

  if attributes.key?(:'scim_clients')
    if (value = attributes[:'scim_clients']).is_a?(Array)
      self.scim_clients = value
    end
  else
    self.scim_clients = nil
  end

  if attributes.key?(:'scim_enabled')
    self.scim_enabled = attributes[:'scim_enabled']
  else
    self.scim_enabled = nil
  end

  if attributes.key?(:'sso_enabled')
    self.sso_enabled = attributes[:'sso_enabled']
  else
    self.sso_enabled = nil
  end
end

Instance Attribute Details

#base_url ⇒ Object

Returns the value of attribute base_url.



18
19
20
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 18

def base_url
  @base_url
end

#kratos_selfservice_methods_oidc_config_providers ⇒ Object

Returns the value of attribute kratos_selfservice_methods_oidc_config_providers.



20
21
22
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 20

def kratos_selfservice_methods_oidc_config_providers
  @kratos_selfservice_methods_oidc_config_providers
end

#kratos_selfservice_methods_saml_config_providers ⇒ Object

Returns the value of attribute kratos_selfservice_methods_saml_config_providers.



22
23
24
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 22

def kratos_selfservice_methods_saml_config_providers
  @kratos_selfservice_methods_saml_config_providers
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



24
25
26
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 24

def organization_id
  @organization_id
end

#organization_label ⇒ Object

Organization Label



27
28
29
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 27

def organization_label
  @organization_label
end

#proxy_acs_url ⇒ Object

Proxy ACS URL if overriding with a customer-controlled URL



30
31
32
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 30

def proxy_acs_url
  @proxy_acs_url
end

#proxy_oidc_redirect_url ⇒ Object

Proxy OIDC Redirect URL if overriding with a customer-controlled URL



33
34
35
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 33

def proxy_oidc_redirect_url
  @proxy_oidc_redirect_url
end

#proxy_saml_audience_override ⇒ Object

SAML Audience Override if overriding with a customer-controlled one



36
37
38
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 36

def proxy_saml_audience_override
  @proxy_saml_audience_override
end

#proxy_scim_server_url ⇒ Object

Proxy SCIM Server URL if overriding with a customer-controlled URL



39
40
41
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 39

def proxy_scim_server_url
  @proxy_scim_server_url
end

#revision_id ⇒ Object

Returns the value of attribute revision_id.



41
42
43
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 41

def revision_id
  @revision_id
end

#scim_clients ⇒ Object

Returns the value of attribute scim_clients.



43
44
45
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 43

def scim_clients
  @scim_clients
end

#scim_enabled ⇒ Object

Returns the value of attribute scim_enabled.



45
46
47
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 45

def scim_enabled
  @scim_enabled
end

#sso_enabled ⇒ Object

Returns the value of attribute sso_enabled.



47
48
49
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 47

def sso_enabled
  @sso_enabled
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 388

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



69
70
71
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 69

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 74

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 50

def self.attribute_map
  {
    :'base_url' => :'base_url',
    :'kratos_selfservice_methods_oidc_config_providers' => :'kratos_selfservice_methods_oidc_config_providers',
    :'kratos_selfservice_methods_saml_config_providers' => :'kratos_selfservice_methods_saml_config_providers',
    :'organization_id' => :'organization_id',
    :'organization_label' => :'organization_label',
    :'proxy_acs_url' => :'proxy_acs_url',
    :'proxy_oidc_redirect_url' => :'proxy_oidc_redirect_url',
    :'proxy_saml_audience_override' => :'proxy_saml_audience_override',
    :'proxy_scim_server_url' => :'proxy_scim_server_url',
    :'revision_id' => :'revision_id',
    :'scim_clients' => :'scim_clients',
    :'scim_enabled' => :'scim_enabled',
    :'sso_enabled' => :'sso_enabled'
  }
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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 364

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 98

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 79

def self.openapi_types
  {
    :'base_url' => :'String',
    :'kratos_selfservice_methods_oidc_config_providers' => :'Array<NormalizedProjectRevisionThirdPartyProvider>',
    :'kratos_selfservice_methods_saml_config_providers' => :'Array<NormalizedProjectRevisionSAMLProvider>',
    :'organization_id' => :'String',
    :'organization_label' => :'String',
    :'proxy_acs_url' => :'String',
    :'proxy_oidc_redirect_url' => :'String',
    :'proxy_saml_audience_override' => :'String',
    :'proxy_scim_server_url' => :'String',
    :'revision_id' => :'String',
    :'scim_clients' => :'Array<NormalizedProjectRevisionScimClient>',
    :'scim_enabled' => :'Boolean',
    :'sso_enabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base_url == o.base_url &&
      kratos_selfservice_methods_oidc_config_providers == o.kratos_selfservice_methods_oidc_config_providers &&
      kratos_selfservice_methods_saml_config_providers == o.kratos_selfservice_methods_saml_config_providers &&
      organization_id == o.organization_id &&
      organization_label == o.organization_label &&
      proxy_acs_url == o.proxy_acs_url &&
      proxy_oidc_redirect_url == o.proxy_oidc_redirect_url &&
      proxy_saml_audience_override == o.proxy_saml_audience_override &&
      proxy_scim_server_url == o.proxy_scim_server_url &&
      revision_id == o.revision_id &&
      scim_clients == o.scim_clients &&
      scim_enabled == o.scim_enabled &&
      sso_enabled == o.sso_enabled
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 459

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


351
352
353
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



357
358
359
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 357

def hash
  [base_url, kratos_selfservice_methods_oidc_config_providers, kratos_selfservice_methods_saml_config_providers, organization_id, organization_label, proxy_acs_url, proxy_oidc_redirect_url, proxy_saml_audience_override, proxy_scim_server_url, revision_id, scim_clients, scim_enabled, sso_enabled].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 196

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @base_url.nil?
    invalid_properties.push('invalid value for "base_url", base_url cannot be nil.')
  end

  if @kratos_selfservice_methods_oidc_config_providers.nil?
    invalid_properties.push('invalid value for "kratos_selfservice_methods_oidc_config_providers", kratos_selfservice_methods_oidc_config_providers cannot be nil.')
  end

  if @kratos_selfservice_methods_saml_config_providers.nil?
    invalid_properties.push('invalid value for "kratos_selfservice_methods_saml_config_providers", kratos_selfservice_methods_saml_config_providers cannot be nil.')
  end

  if @organization_id.nil?
    invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
  end

  if @revision_id.nil?
    invalid_properties.push('invalid value for "revision_id", revision_id cannot be nil.')
  end

  if @scim_clients.nil?
    invalid_properties.push('invalid value for "scim_clients", scim_clients cannot be nil.')
  end

  if @scim_enabled.nil?
    invalid_properties.push('invalid value for "scim_enabled", scim_enabled cannot be nil.')
  end

  if @sso_enabled.nil?
    invalid_properties.push('invalid value for "sso_enabled", sso_enabled cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



435
436
437
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 435

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 441

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



429
430
431
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 429

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ory-client/models/onboarding_portal_organization.rb', line 236

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @base_url.nil?
  return false if @kratos_selfservice_methods_oidc_config_providers.nil?
  return false if @kratos_selfservice_methods_saml_config_providers.nil?
  return false if @organization_id.nil?
  return false if @revision_id.nil?
  return false if @scim_clients.nil?
  return false if @scim_enabled.nil?
  return false if @sso_enabled.nil?
  true
end