Class: Zyphr::ApplicationSelf

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/models/application_self.rb

Overview

Non-sensitive metadata about the authenticating application. Returned by GET /auth/application so an integrator can read their own application_id (the sole tenant discriminator embedded in end-user tokens) directly from the API. Never includes secrets, signing keys, or account-internal fields.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationSelf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zyphr/models/application_self.rb', line 107

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

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

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

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

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

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

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

Instance Attribute Details

#auth_email_mode ⇒ Object

Explicit auth-email gate mode (sc-7673). unrestricted sends auth emails to everyone. allowlist restricts auth email to test_recipients — and an EMPTY allowlist in this mode fails CLOSED (blocks all auth email). This replaces the previous behavior where the gate was inferred from whether test_recipients was empty. Defaults to unrestricted.



35
36
37
 
# File 'lib/zyphr/models/application_self.rb', line 35

def auth_email_mode
  @auth_email_mode
end

#environment ⇒ Object

The environment mode of the credentials used to authenticate this request. null when the environment cannot be determined (e.g. a legacy application-level key that predates environment-scoped keys) — not defaulted to a guessed value.



26
27
28
 
# File 'lib/zyphr/models/application_self.rb', line 26

def environment
  @environment
end

#id ⇒ Object

The application's unique id (application_id).



20
21
22
 
# File 'lib/zyphr/models/application_self.rb', line 20

def id
  @id
end

#name ⇒ Object

Human-readable application name.



23
24
25
 
# File 'lib/zyphr/models/application_self.rb', line 23

def name
  @name
end

#password_disallow_breached ⇒ Object

When true (sc-7680), passwords found in the HaveIBeenPwned breach corpus are rejected at register/reset (and returned valid:false by /auth/password-strength). When false (default), breach info is advisory only. Fail-open: a breach-source outage never blocks auth.



38
39
40
 
# File 'lib/zyphr/models/application_self.rb', line 38

def password_disallow_breached
  @password_disallow_breached
end

#signing_algorithm ⇒ Object

JWT signing algorithm for this application's end-user tokens.



29
30
31
 
# File 'lib/zyphr/models/application_self.rb', line 29

def signing_algorithm
  @signing_algorithm
end

#test_recipients ⇒ Object

The auth-email allowlist. In allowlist mode, only these addresses receive auth emails; in unrestricted mode it is ignored. Settable via PATCH /auth/application (sc-7600).



32
33
34
 
# File 'lib/zyphr/models/application_self.rb', line 32

def test_recipients
  @test_recipients
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/zyphr/models/application_self.rb', line 340

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 = Zyphr.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



76
77
78
 
# File 'lib/zyphr/models/application_self.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zyphr/models/application_self.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zyphr/models/application_self.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'environment' => :'environment',
    :'signing_algorithm' => :'signing_algorithm',
    :'test_recipients' => :'test_recipients',
    :'auth_email_mode' => :'auth_email_mode',
    :'password_disallow_breached' => :'password_disallow_breached'
  }
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/zyphr/models/application_self.rb', line 316

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



99
100
101
102
103
 
# File 'lib/zyphr/models/application_self.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/zyphr/models/application_self.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'environment' => :'String',
    :'signing_algorithm' => :'String',
    :'test_recipients' => :'Array<String>',
    :'auth_email_mode' => :'String',
    :'password_disallow_breached' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/zyphr/models/application_self.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      environment == o.environment &&
      signing_algorithm == o.signing_algorithm &&
      test_recipients == o.test_recipients &&
      auth_email_mode == o.auth_email_mode &&
      password_disallow_breached == o.password_disallow_breached
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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/zyphr/models/application_self.rb', line 411

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


303
304
305
 
# File 'lib/zyphr/models/application_self.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



309
310
311
 
# File 'lib/zyphr/models/application_self.rb', line 309

def hash
  [id, name, environment, signing_algorithm, test_recipients, auth_email_mode, password_disallow_breached].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



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
 
# File 'lib/zyphr/models/application_self.rb', line 168

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

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

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

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

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

  if @password_disallow_breached.nil?
    invalid_properties.push('invalid value for "password_disallow_breached", password_disallow_breached 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



387
388
389
 
# File 'lib/zyphr/models/application_self.rb', line 387

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/zyphr/models/application_self.rb', line 393

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



381
382
383
 
# File 'lib/zyphr/models/application_self.rb', line 381

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/zyphr/models/application_self.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  environment_validator = EnumAttributeValidator.new('String', ["test", "live"])
  return false unless environment_validator.valid?(@environment)
  return false if @signing_algorithm.nil?
  signing_algorithm_validator = EnumAttributeValidator.new('String', ["HS256", "RS256", "ES256"])
  return false unless signing_algorithm_validator.valid?(@signing_algorithm)
  return false if @test_recipients.nil?
  return false if @auth_email_mode.nil?
  auth_email_mode_validator = EnumAttributeValidator.new('String', ["allowlist", "unrestricted"])
  return false unless auth_email_mode_validator.valid?(@auth_email_mode)
  return false if @password_disallow_breached.nil?
  true
end