Class: OryClient::NormalizedProjectRevisionScimClient

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

Overview

SCIMClient represents a SCIM client configuration to be used by an external identity provider.

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ NormalizedProjectRevisionScimClient

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 120

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authorization_header_secret ⇒ Object

The secret that the client uses in the authorization header to authenticate itself.



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

def authorization_header_secret
  @authorization_header_secret
end

#client_id ⇒ Object

The unique ID of the SCIM server.



23
24
25
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 23

def client_id
  @client_id
end

#created_at ⇒ Object

The SCIM client’s creation time



26
27
28
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 26

def created_at
  @created_at
end

#id ⇒ Object

Returns the value of attribute id.



28
29
30
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 28

def id
  @id
end

#label ⇒ Object

The SCIM server’s label



31
32
33
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 31

def label
  @label
end

#mapper_url ⇒ Object

Mapper specifies the JSONNet code snippet which uses the SCIM provider’s data to hydrate the identity’s data.



34
35
36
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 34

def mapper_url
  @mapper_url
end

#organization_id ⇒ Object

OrganizationID is the organization ID for this SCIM server.



37
38
39
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 37

def organization_id
  @organization_id
end

#proxy_scim_server_url ⇒ Object

Returns the value of attribute proxy_scim_server_url.



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

def proxy_scim_server_url
  @proxy_scim_server_url
end

#state ⇒ Object

State indicates the state of the SCIM server Only servers with state enabled will be available for SCIM provisioning. enabled ThirdPartyProviderStateEnabled disabled ThirdPartyProviderStateDisabled



42
43
44
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 42

def state
  @state
end

#updated_at ⇒ Object

Last time the SCIM client was updated



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



86
87
88
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 86

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 91

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 70

def self.attribute_map
  {
    :'authorization_header_secret' => :'authorization_header_secret',
    :'client_id' => :'client_id',
    :'created_at' => :'created_at',
    :'id' => :'id',
    :'label' => :'label',
    :'mapper_url' => :'mapper_url',
    :'organization_id' => :'organization_id',
    :'proxy_scim_server_url' => :'proxy_scim_server_url',
    :'state' => :'state',
    :'updated_at' => :'updated_at'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 319

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



112
113
114
115
116
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 96

def self.openapi_types
  {
    :'authorization_header_secret' => :'String',
    :'client_id' => :'String',
    :'created_at' => :'Time',
    :'id' => :'String',
    :'label' => :'String',
    :'mapper_url' => :'String',
    :'organization_id' => :'String',
    :'proxy_scim_server_url' => :'String',
    :'state' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorization_header_secret == o.authorization_header_secret &&
      client_id == o.client_id &&
      created_at == o.created_at &&
      id == o.id &&
      label == o.label &&
      mapper_url == o.mapper_url &&
      organization_id == o.organization_id &&
      proxy_scim_server_url == o.proxy_scim_server_url &&
      state == o.state &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


306
307
308
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



312
313
314
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 312

def hash
  [authorization_header_secret, client_id, created_at, id, label, mapper_url, organization_id, proxy_scim_server_url, state, updated_at].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



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
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 187

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 341

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:

  • true if the model is valid



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/ory-client/models/normalized_project_revision_scim_client.rb', line 215

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @authorization_header_secret.nil?
  return false if @client_id.nil?
  return false if @label.nil?
  return false if @mapper_url.nil?
  return false if @organization_id.nil?
  state_validator = EnumAttributeValidator.new('String', ["enabled", "disabled"])
  return false unless state_validator.valid?(@state)
  true
end