Class: Zitadel::Client::Models::FeatureServiceSetSystemFeaturesRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/zitadel/client/models/feature_service_set_system_features_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FeatureServiceSetSystemFeaturesRequest

Initializes the object



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
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
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 102

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    # MODIFIED: Updated class name in error message
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zitadel::Client::Models::FeatureServiceSetSystemFeaturesRequest` 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))
      # MODIFIED: Updated class name in error message
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zitadel::Client::Models::FeatureServiceSetSystemFeaturesRequest`. 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?(:'login_default_org')
    self. = attributes[:'login_default_org']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#disable_user_token_event ⇒ Object

Do not push user token meta-event user.token.v2.added to improve performance on many concurrent single (machine-)user logins



40
41
42
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 40

def disable_user_token_event
  @disable_user_token_event
end

#enable_back_channel_logout ⇒ Object

If the flag is enabled, you’ll be able to use the OIDC Back-Channel Logout to be notified in your application about terminated user sessions.



43
44
45
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 43

def enable_back_channel_logout
  @enable_back_channel_logout
end

#improved_performance ⇒ Object

Improves performance of specified execution paths.



34
35
36
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 34

def improved_performance
  @improved_performance
end

#login_default_org ⇒ Object

The login UI will use the settings of the default org (and not from the instance) if no organization context is set



19
20
21
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 19

def 
  @login_default_org
end

#login_v2 ⇒ Object

Returns the value of attribute login_v2.



45
46
47
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 45

def 
  @login_v2
end

#oidc_legacy_introspection ⇒ Object

We have recently refactored the introspection endpoint for performance reasons. This feature can be used to rollback to the legacy implementation if unexpected bugs arise. Please raise an issue if you needed to enable this feature.



25
26
27
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 25

def oidc_legacy_introspection
  @oidc_legacy_introspection
end

#oidc_single_v1_session_termination ⇒ Object

If the flag is enabled, you’ll be able to terminate a single session from the login UI by providing an id_token with a ‘sid` claim as id_token_hint on the end_session endpoint. Note that currently all sessions from the same user agent (browser) are terminated in the login UI. Sessions managed through the Session API already allow the termination of single sessions.



37
38
39
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 37

def oidc_single_v1_session_termination
  @oidc_single_v1_session_termination
end

#oidc_token_exchange ⇒ Object

Enable the experimental ‘urn:ietf:params:oauth:grant-type:token-exchange` grant type for the OIDC token endpoint. Token exchange can be used to request tokens with a lesser scope or impersonate other users. See the security policy to allow impersonation on an instance.



31
32
33
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 31

def oidc_token_exchange
  @oidc_token_exchange
end

#oidc_trigger_introspection_projections ⇒ Object

Enable projection triggers during an introspection request. This can act as workaround if there are noticeable consistency issues in the introspection response but can have an impact on performance. We are planning to remove triggers for introspection requests in the future. Please raise an issue if you needed to enable this feature.



22
23
24
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 22

def oidc_trigger_introspection_projections
  @oidc_trigger_introspection_projections
end

#permission_check_v2 ⇒ Object

Enable a newer, more performant, permission check used for v2 and v3 resource based APIs.



48
49
50
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 48

def permission_check_v2
  @permission_check_v2
end

#user_schema ⇒ Object

User Schemas allow to manage data schemas of user. If the flag is enabled, you’ll be able to use the new API and its features. Note that it is still in an early stage.



28
29
30
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 28

def user_schema
  @user_schema
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 237

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/anyOf constructs that resolve to a model name
    # MODIFIED: Ensure model is looked up in the Models namespace
    # 'type' here is expected to be the simple class name (e.g., "User", "OrderDetails")
    klass = Zitadel::Client::Models.const_get(type)
    # The `klass.build` method is for oneOf/anyOf types (defined in partial_oneof_module.mustache / partial_anyof_module.mustache)
    # The `klass.build_from_hash` is for regular model types (defined in this base_object.mustache itself)
    if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_allOf)
      klass.build(value) # For oneOf/anyOf/allOf, delegate to their specific build method
    else
      klass.build_from_hash(value) # For regular models
    end
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 51

def self.attribute_map
  {
    :'login_default_org' => :'loginDefaultOrg',
    :'oidc_trigger_introspection_projections' => :'oidcTriggerIntrospectionProjections',
    :'oidc_legacy_introspection' => :'oidcLegacyIntrospection',
    :'user_schema' => :'userSchema',
    :'oidc_token_exchange' => :'oidcTokenExchange',
    :'improved_performance' => :'improvedPerformance',
    :'oidc_single_v1_session_termination' => :'oidcSingleV1SessionTermination',
    :'disable_user_token_event' => :'disableUserTokenEvent',
    :'enable_back_channel_logout' => :'enableBackChannelLogout',
    :'login_v2' => :'loginV2',
    :'permission_check_v2' => :'permissionCheckV2'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 213

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) # `new` will call the initialize method of the specific model class.
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 95

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 78

def self.openapi_types
  {
    :'login_default_org' => :'Boolean',
    :'oidc_trigger_introspection_projections' => :'Boolean',
    :'oidc_legacy_introspection' => :'Boolean',
    :'user_schema' => :'Boolean',
    :'oidc_token_exchange' => :'Boolean',
    :'improved_performance' => :'Array<FeatureServiceImprovedPerformance>',
    :'oidc_single_v1_session_termination' => :'Boolean',
    :'disable_user_token_event' => :'Boolean',
    :'enable_back_channel_logout' => :'Boolean',
    :'login_v2' => :'FeatureServiceLoginV2',
    :'permission_check_v2' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      oidc_trigger_introspection_projections == o.oidc_trigger_introspection_projections &&
      oidc_legacy_introspection == o.oidc_legacy_introspection &&
      user_schema == o.user_schema &&
      oidc_token_exchange == o.oidc_token_exchange &&
      improved_performance == o.improved_performance &&
      oidc_single_v1_session_termination == o.oidc_single_v1_session_termination &&
      disable_user_token_event == o.disable_user_token_event &&
      enable_back_channel_logout == o.enable_back_channel_logout &&
       == o. &&
      permission_check_v2 == o.permission_check_v2
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 316

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

See Also:

  • `==` method


200
201
202
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



206
207
208
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 206

def hash
  [, oidc_trigger_introspection_projections, oidc_legacy_introspection, user_schema, oidc_token_exchange, improved_performance, oidc_single_v1_session_termination, disable_user_token_event, enable_back_channel_logout, , permission_check_v2].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



167
168
169
170
171
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 167

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



292
293
294
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 292

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 298

def to_hash
  hash = {} # Calls super.to_hash if parent exists
  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



286
287
288
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 286

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



175
176
177
178
 
# File 'lib/zitadel/client/models/feature_service_set_system_features_request.rb', line 175

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