Class: OryClient::UpdateRegistrationFlowWithOidcMethod

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

Overview

Update Registration Flow with OpenID Connect Method

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 89

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

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

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

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

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

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

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

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

Instance Attribute Details

#csrf_token ⇒ Object

The CSRF Token



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

def csrf_token
  @csrf_token
end

#id_token ⇒ Object

IDToken is an optional id token provided by an OIDC provider If submitted, it is verified using the OIDC provider’s public key set and the claims are used to populate the OIDC credentials of the identity. If the OIDC provider does not store additional claims (such as name, etc.) in the IDToken itself, you can use the traits field to populate the identity’s traits. Note, that Apple only includes the users email in the IDToken. Supported providers are Apple Google



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

def id_token
  @id_token
end

#id_token_nonce ⇒ Object

IDTokenNonce is the nonce, used when generating the IDToken. If the provider supports nonce validation, the nonce will be validated against this value and is required.



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

def id_token_nonce
  @id_token_nonce
end

#method ⇒ Object

Method to use This field must be set to oidc when using the oidc method.



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

def method
  @method
end

#provider ⇒ Object

The provider to register with



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

def provider
  @provider
end

#traits ⇒ Object

The identity traits



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

def traits
  @traits
end

#transient_payload ⇒ Object

Transient data to pass along to any webhooks



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

def transient_payload
  @transient_payload
end

#upstream_parameters ⇒ Object

UpstreamParameters are the parameters that are passed to the upstream identity provider. These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are: login_hint (string): The login_hint parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session. hd (string): The hd parameter limits the login/registration process to a Google Organization, e.g. mycollege.edu. prompt (string): The prompt specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. select_account.



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

def upstream_parameters
  @upstream_parameters
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 44

def self.attribute_map
  {
    :'csrf_token' => :'csrf_token',
    :'id_token' => :'id_token',
    :'id_token_nonce' => :'id_token_nonce',
    :'method' => :'method',
    :'provider' => :'provider',
    :'traits' => :'traits',
    :'transient_payload' => :'transient_payload',
    :'upstream_parameters' => :'upstream_parameters'
  }
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 215

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 68

def self.openapi_types
  {
    :'csrf_token' => :'String',
    :'id_token' => :'String',
    :'id_token_nonce' => :'String',
    :'method' => :'String',
    :'provider' => :'String',
    :'traits' => :'Object',
    :'transient_payload' => :'Object',
    :'upstream_parameters' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      csrf_token == o.csrf_token &&
      id_token == o.id_token &&
      id_token_nonce == o.id_token_nonce &&
      method == o.method &&
      provider == o.provider &&
      traits == o.traits &&
      transient_payload == o.transient_payload &&
      upstream_parameters == o.upstream_parameters
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


202
203
204
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 208

def hash
  [csrf_token, id_token, id_token_nonce, method, provider, traits, transient_payload, upstream_parameters].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



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 142

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

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



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

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



158
159
160
161
162
163
 
# File 'lib/ory-client/models/update_registration_flow_with_oidc_method.rb', line 158

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