Class: OryClient::CreateOrganizationOnboardingPortalLinkBody

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateOrganizationOnboardingPortalLinkBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
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
233
234
235
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 142

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::CreateOrganizationOnboardingPortalLinkBody` 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::CreateOrganizationOnboardingPortalLinkBody`. 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?(:'apple_mapper_url')
    self.apple_mapper_url = attributes[:'apple_mapper_url']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'netid_mapper_url')
    self.netid_mapper_url = attributes[:'netid_mapper_url']
  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?(:'saml_mapper_url')
    self.saml_mapper_url = attributes[:'saml_mapper_url']
  end

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

Instance Attribute Details

#apple_mapper_url ⇒ Object

AppleMapper specifies the JSONNet code snippet which uses Apple’s profile information to hydrate the identity’s data.



19
20
21
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 19

def apple_mapper_url
  @apple_mapper_url
end

#auth0_mapper_url ⇒ Object

Auth0Mapper specifies the JSONNet code snippet which uses Auth0’s profile information to hydrate the identity’s data.



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

def auth0_mapper_url
  @auth0_mapper_url
end

#custom_hostname_id ⇒ Object

Returns the value of attribute custom_hostname_id.



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

def custom_hostname_id
  @custom_hostname_id
end

#enable_scim ⇒ Object

Feature flag to enable SCIM configuration



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

def enable_scim
  @enable_scim
end

#enable_sso ⇒ Object

Feature flag to enable SSO configuration



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

def enable_sso
  @enable_sso
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



32
33
34
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 32

def expires_at
  @expires_at
end

#facebook_mapper_url ⇒ Object

FacebookMapper specifies the JSONNet code snippet which uses Facebook’s profile information to hydrate the identity’s data.



35
36
37
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 35

def facebook_mapper_url
  @facebook_mapper_url
end

#generic_oidc_mapper_url ⇒ Object

GenericOIDCMapper specifies the JSONNet code snippet which uses the OIDC Provider’s profile information to hydrate the identity’s data.



38
39
40
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 38

def generic_oidc_mapper_url
  @generic_oidc_mapper_url
end

#github_mapper_url ⇒ Object

GithubMapper specifies the JSONNet code snippet which uses GitHub’s profile information to hydrate the identity’s data.



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

def github_mapper_url
  @github_mapper_url
end

#gitlab_mapper_url ⇒ Object

GitLabMapper specifies the JSONNet code snippet which uses GitLab’s profile information to hydrate the identity’s data.



44
45
46
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 44

def gitlab_mapper_url
  @gitlab_mapper_url
end

#google_mapper_url ⇒ Object

GoogleMapper specifies the JSONNet code snippet which uses Google’s profile information to hydrate the identity’s data.



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

def google_mapper_url
  @google_mapper_url
end

#microsoft_mapper_url ⇒ Object

MicrosoftMapper specifies the JSONNet code snippet which uses Microsoft’s profile information to hydrate the identity’s data.



50
51
52
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 50

def microsoft_mapper_url
  @microsoft_mapper_url
end

#netid_mapper_url ⇒ Object

NetIDMapper specifies the JSONNet code snippet which uses NetID’s profile information to hydrate the identity’s data.



53
54
55
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 53

def netid_mapper_url
  @netid_mapper_url
end

#proxy_acs_url ⇒ Object

Proxy ACS URL if overriding with a customer-controlled URL



56
57
58
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 56

def proxy_acs_url
  @proxy_acs_url
end

#proxy_oidc_redirect_url ⇒ Object

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



59
60
61
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 59

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



62
63
64
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 62

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



65
66
67
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 65

def proxy_scim_server_url
  @proxy_scim_server_url
end

#saml_mapper_url ⇒ Object

SAMLMapper specifies the JSONNet code snippet which uses the SAML Provider’s profile information to hydrate the identity’s data.



68
69
70
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 68

def saml_mapper_url
  @saml_mapper_url
end

#scim_mapper_url ⇒ Object

SCIMMapper specifies the JSONNet code snippet which uses the SCIM Provider’s profile information to hydrate the identity’s data.



71
72
73
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 71

def scim_mapper_url
  @scim_mapper_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 104

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 74

def self.attribute_map
  {
    :'apple_mapper_url' => :'apple_mapper_url',
    :'auth0_mapper_url' => :'auth0_mapper_url',
    :'custom_hostname_id' => :'custom_hostname_id',
    :'enable_scim' => :'enable_scim',
    :'enable_sso' => :'enable_sso',
    :'expires_at' => :'expires_at',
    :'facebook_mapper_url' => :'facebook_mapper_url',
    :'generic_oidc_mapper_url' => :'generic_oidc_mapper_url',
    :'github_mapper_url' => :'github_mapper_url',
    :'gitlab_mapper_url' => :'gitlab_mapper_url',
    :'google_mapper_url' => :'google_mapper_url',
    :'microsoft_mapper_url' => :'microsoft_mapper_url',
    :'netid_mapper_url' => :'netid_mapper_url',
    :'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',
    :'saml_mapper_url' => :'saml_mapper_url',
    :'scim_mapper_url' => :'scim_mapper_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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 323

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



134
135
136
137
138
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 134

def self.openapi_nullable
  Set.new([
    :'custom_hostname_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 109

def self.openapi_types
  {
    :'apple_mapper_url' => :'String',
    :'auth0_mapper_url' => :'String',
    :'custom_hostname_id' => :'String',
    :'enable_scim' => :'Boolean',
    :'enable_sso' => :'Boolean',
    :'expires_at' => :'Time',
    :'facebook_mapper_url' => :'String',
    :'generic_oidc_mapper_url' => :'String',
    :'github_mapper_url' => :'String',
    :'gitlab_mapper_url' => :'String',
    :'google_mapper_url' => :'String',
    :'microsoft_mapper_url' => :'String',
    :'netid_mapper_url' => :'String',
    :'proxy_acs_url' => :'String',
    :'proxy_oidc_redirect_url' => :'String',
    :'proxy_saml_audience_override' => :'String',
    :'proxy_scim_server_url' => :'String',
    :'saml_mapper_url' => :'String',
    :'scim_mapper_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apple_mapper_url == o.apple_mapper_url &&
      auth0_mapper_url == o.auth0_mapper_url &&
      custom_hostname_id == o.custom_hostname_id &&
      enable_scim == o.enable_scim &&
      enable_sso == o.enable_sso &&
      expires_at == o.expires_at &&
      facebook_mapper_url == o.facebook_mapper_url &&
      generic_oidc_mapper_url == o.generic_oidc_mapper_url &&
      github_mapper_url == o.github_mapper_url &&
      gitlab_mapper_url == o.gitlab_mapper_url &&
      google_mapper_url == o.google_mapper_url &&
      microsoft_mapper_url == o.microsoft_mapper_url &&
      netid_mapper_url == o.netid_mapper_url &&
      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 &&
      saml_mapper_url == o.saml_mapper_url &&
      scim_mapper_url == o.scim_mapper_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


310
311
312
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 316

def hash
  [apple_mapper_url, auth0_mapper_url, custom_hostname_id, enable_scim, enable_sso, expires_at, facebook_mapper_url, generic_oidc_mapper_url, github_mapper_url, gitlab_mapper_url, google_mapper_url, microsoft_mapper_url, netid_mapper_url, proxy_acs_url, proxy_oidc_redirect_url, proxy_saml_audience_override, proxy_scim_server_url, saml_mapper_url, scim_mapper_url].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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 239

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 345

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



255
256
257
258
259
260
 
# File 'lib/ory-client/models/create_organization_onboarding_portal_link_body.rb', line 255

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @enable_scim.nil?
  return false if @enable_sso.nil?
  true
end