Class: OryClient::IntrospectedOAuth2Token

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

Overview

Introspection contains an access token’s session data as specified by [IETF RFC 7662](tools.ietf.org/html/rfc7662)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IntrospectedOAuth2Token

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Active is a boolean indicator of whether or not the presented token is currently active. The specifics of a token’s "active" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a "true" value return for the "active" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time).



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

def active
  @active
end

#aud ⇒ Object

Audience contains a list of the token’s intended audiences.



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

def aud
  @aud
end

#client_id ⇒ Object

ID is aclient identifier for the OAuth 2.0 client that requested this token.



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

def client_id
  @client_id
end

#exp ⇒ Object

Expires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.



29
30
31
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 29

def exp
  @exp
end

#ext ⇒ Object

Extra is arbitrary data set by the session.



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

def ext
  @ext
end

#iat ⇒ Object

Issued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued.



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

def iat
  @iat
end

#iss ⇒ Object

IssuerURL is a string representing the issuer of this token



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

def iss
  @iss
end

#nbf ⇒ Object

NotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before.



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

def nbf
  @nbf
end

#obfuscated_subject ⇒ Object

ObfuscatedSubject is set when the subject identifier algorithm was set to "pairwise" during authorization. It is the ‘sub` value of the ID Token that was issued.



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

def obfuscated_subject
  @obfuscated_subject
end

#scope ⇒ Object

Scope is a JSON string containing a space-separated list of scopes associated with this token.



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

def scope
  @scope
end

#sub ⇒ Object

Subject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token.



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

def sub
  @sub
end

#token_type ⇒ Object

TokenType is the introspected token’s type, typically ‘Bearer`.



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

def token_type
  @token_type
end

#token_use ⇒ Object

TokenUse is the introspected token’s use, for example ‘access_token` or `refresh_token`.



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

def token_use
  @token_use
end

#username ⇒ Object

Username is a human-readable identifier for the resource owner who authorized this token.



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

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 270

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 62

def self.attribute_map
  {
    :'active' => :'active',
    :'aud' => :'aud',
    :'client_id' => :'client_id',
    :'exp' => :'exp',
    :'ext' => :'ext',
    :'iat' => :'iat',
    :'iss' => :'iss',
    :'nbf' => :'nbf',
    :'obfuscated_subject' => :'obfuscated_subject',
    :'scope' => :'scope',
    :'sub' => :'sub',
    :'token_type' => :'token_type',
    :'token_use' => :'token_use',
    :'username' => :'username'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 246

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



107
108
109
110
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 87

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'aud' => :'Array<String>',
    :'client_id' => :'String',
    :'exp' => :'Integer',
    :'ext' => :'Hash<String, Object>',
    :'iat' => :'Integer',
    :'iss' => :'String',
    :'nbf' => :'Integer',
    :'obfuscated_subject' => :'String',
    :'scope' => :'String',
    :'sub' => :'String',
    :'token_type' => :'String',
    :'token_use' => :'String',
    :'username' => :'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
226
227
228
229
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      aud == o.aud &&
      client_id == o.client_id &&
      exp == o.exp &&
      ext == o.ext &&
      iat == o.iat &&
      iss == o.iss &&
      nbf == o.nbf &&
      obfuscated_subject == o.obfuscated_subject &&
      scope == o.scope &&
      sub == o.sub &&
      token_type == o.token_type &&
      token_use == o.token_use &&
      username == o.username
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



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

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


233
234
235
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 239

def hash
  [active, aud, client_id, exp, ext, iat, iss, nbf, obfuscated_subject, scope, sub, token_type, token_use, username].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



192
193
194
195
196
197
198
199
200
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 192

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @active.nil?
    invalid_properties.push('invalid value for "active", active 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



317
318
319
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 323

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



311
312
313
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 311

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



204
205
206
207
208
 
# File 'lib/ory-client/models/introspected_o_auth2_token.rb', line 204

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