Class: OryClient::Session

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/session.rb

Overview

A Session

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Active state. If false the session is no longer active.



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

def active
  @active
end

#authenticated_at ⇒ Object

The Session Authentication Timestamp When this session was authenticated at. If multi-factor authentication was used this is the time when the last factor was authenticated (e.g. the TOTP code challenge was completed).



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

def authenticated_at
  @authenticated_at
end

#authentication_methods ⇒ Object

A list of authenticators which were used to authenticate the session.



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

def authentication_methods
  @authentication_methods
end

#authenticator_assurance_level ⇒ Object

Returns the value of attribute authenticator_assurance_level.



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

def authenticator_assurance_level
  @authenticator_assurance_level
end

#devices ⇒ Object

Devices has history of all endpoints where the session was used



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

def devices
  @devices
end

#expires_at ⇒ Object

The Session Expiry When this session expires at.



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

def expires_at
  @expires_at
end

#id ⇒ Object

Session ID



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

def id
  @id
end

#identity ⇒ Object

Returns the value of attribute identity.



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

def identity
  @identity
end

#issued_at ⇒ Object

The Session Issuance Timestamp When this session was issued at. Usually equal or close to authenticated_at.



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

def issued_at
  @issued_at
end

#tokenized ⇒ Object

Tokenized is the tokenized (e.g. JWT) version of the session. It is only set when the tokenize_as query parameter was set to a valid tokenize template during calls to /session/whoami.



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

def tokenized
  @tokenized
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



86
87
88
 
# File 'lib/ory-client/models/session.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/session.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/session.rb', line 70

def self.attribute_map
  {
    :'active' => :'active',
    :'authenticated_at' => :'authenticated_at',
    :'authentication_methods' => :'authentication_methods',
    :'authenticator_assurance_level' => :'authenticator_assurance_level',
    :'devices' => :'devices',
    :'expires_at' => :'expires_at',
    :'id' => :'id',
    :'identity' => :'identity',
    :'issued_at' => :'issued_at',
    :'tokenized' => :'tokenized'
  }
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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ory-client/models/session.rb', line 242

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

def self.openapi_nullable
  Set.new([
  ])
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/session.rb', line 96

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'authenticated_at' => :'Time',
    :'authentication_methods' => :'Array<SessionAuthenticationMethod>',
    :'authenticator_assurance_level' => :'AuthenticatorAssuranceLevel',
    :'devices' => :'Array<SessionDevice>',
    :'expires_at' => :'Time',
    :'id' => :'String',
    :'identity' => :'Identity',
    :'issued_at' => :'Time',
    :'tokenized' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      authenticated_at == o.authenticated_at &&
      authentication_methods == o.authentication_methods &&
      authenticator_assurance_level == o.authenticator_assurance_level &&
      devices == o.devices &&
      expires_at == o.expires_at &&
      id == o.id &&
      identity == o.identity &&
      issued_at == o.issued_at &&
      tokenized == o.tokenized
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


229
230
231
 
# File 'lib/ory-client/models/session.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/ory-client/models/session.rb', line 235

def hash
  [active, authenticated_at, authentication_methods, authenticator_assurance_level, devices, expires_at, id, identity, issued_at, tokenized].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



182
183
184
185
186
187
188
189
190
 
# File 'lib/ory-client/models/session.rb', line 182

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ory-client/models/session.rb', line 264

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



194
195
196
197
198
 
# File 'lib/ory-client/models/session.rb', line 194

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