Class: OryClient::Provider

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
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
 
# File 'lib/ory-client/models/provider.rb', line 83

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

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

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

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

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

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

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

Instance Attribute Details

#client_id ⇒ Object

The RP’s client identifier, issued by the IdP.



19
20
21
 
# File 'lib/ory-client/models/provider.rb', line 19

def client_id
  @client_id
end

#config_url ⇒ Object

A full path of the IdP config file.



22
23
24
 
# File 'lib/ory-client/models/provider.rb', line 22

def config_url
  @config_url
end

#domain_hint ⇒ Object

By specifying one of domain_hints values provided by the accounts endpoints, the FedCM dialog selectively shows the specified account.



25
26
27
 
# File 'lib/ory-client/models/provider.rb', line 25

def domain_hint
  @domain_hint
end

#fields ⇒ Object

Array of strings that specifies the user information ("name", " email", "picture") that RP needs IdP to share with them. Note: Field API is supported by Chrome 132 and later.



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

def fields
  @fields
end

#login_hint ⇒ Object

By specifying one of login_hints values provided by the accounts endpoints, the FedCM dialog selectively shows the specified account.



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

def 
  @login_hint
end

#nonce ⇒ Object

A random string to ensure the response is issued for this specific request. Prevents replay attacks.



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

def nonce
  @nonce
end

#parameters ⇒ Object

Custom object that allows to specify additional key-value parameters: scope: A string value containing additional permissions that RP needs to request, for example " drive.readonly calendar.readonly" nonce: A random string to ensure the response is issued for this specific request. Prevents replay attacks. Other custom key-value parameters. Note: parameters is supported from Chrome 132.



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

def parameters
  @parameters
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ory-client/models/provider.rb', line 40

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'config_url' => :'config_url',
    :'domain_hint' => :'domain_hint',
    :'fields' => :'fields',
    :'login_hint' => :'login_hint',
    :'nonce' => :'nonce',
    :'parameters' => :'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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/ory-client/models/provider.rb', line 174

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



76
77
78
79
 
# File 'lib/ory-client/models/provider.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ory-client/models/provider.rb', line 63

def self.openapi_types
  {
    :'client_id' => :'String',
    :'config_url' => :'String',
    :'domain_hint' => :'String',
    :'fields' => :'Array<String>',
    :'login_hint' => :'String',
    :'nonce' => :'String',
    :'parameters' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ory-client/models/provider.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      config_url == o.config_url &&
      domain_hint == o.domain_hint &&
      fields == o.fields &&
       == o. &&
      nonce == o.nonce &&
      parameters == o.parameters
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/ory-client/models/provider.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/ory-client/models/provider.rb', line 167

def hash
  [client_id, config_url, domain_hint, fields, , nonce, 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



132
133
134
135
136
 
# File 'lib/ory-client/models/provider.rb', line 132

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ory-client/models/provider.rb', line 196

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



140
141
142
143
 
# File 'lib/ory-client/models/provider.rb', line 140

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end