Class: OCI::IdentityDomains::Models::AppExtensionRadiusAppApp

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/app_extension_radius_app_app.rb

Overview

This extension defines attributes specific to Apps that represent instances of Radius App.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppExtensionRadiusAppApp

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 321

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.client_ip = attributes[:'clientIP'] if attributes[:'clientIP']

  raise 'You cannot provide both :clientIP and :client_ip' if attributes.key?(:'clientIP') && attributes.key?(:'client_ip')

  self.client_ip = attributes[:'client_ip'] if attributes[:'client_ip']

  self.port = attributes[:'port'] if attributes[:'port']

  self.secret_key = attributes[:'secretKey'] if attributes[:'secretKey']

  raise 'You cannot provide both :secretKey and :secret_key' if attributes.key?(:'secretKey') && attributes.key?(:'secret_key')

  self.secret_key = attributes[:'secret_key'] if attributes[:'secret_key']

  self.secret_key_temporary = attributes[:'secretKeyTemporary'] if attributes[:'secretKeyTemporary']

  raise 'You cannot provide both :secretKeyTemporary and :secret_key_temporary' if attributes.key?(:'secretKeyTemporary') && attributes.key?(:'secret_key_temporary')

  self.secret_key_temporary = attributes[:'secret_key_temporary'] if attributes[:'secret_key_temporary']

  self.include_group_in_response = attributes[:'includeGroupInResponse'] unless attributes[:'includeGroupInResponse'].nil?

  raise 'You cannot provide both :includeGroupInResponse and :include_group_in_response' if attributes.key?(:'includeGroupInResponse') && attributes.key?(:'include_group_in_response')

  self.include_group_in_response = attributes[:'include_group_in_response'] unless attributes[:'include_group_in_response'].nil?

  self.capture_client_ip = attributes[:'captureClientIp'] unless attributes[:'captureClientIp'].nil?

  raise 'You cannot provide both :captureClientIp and :capture_client_ip' if attributes.key?(:'captureClientIp') && attributes.key?(:'capture_client_ip')

  self.capture_client_ip = attributes[:'capture_client_ip'] unless attributes[:'capture_client_ip'].nil?

  self.type_of_radius_app = attributes[:'typeOfRadiusApp'] if attributes[:'typeOfRadiusApp']

  raise 'You cannot provide both :typeOfRadiusApp and :type_of_radius_app' if attributes.key?(:'typeOfRadiusApp') && attributes.key?(:'type_of_radius_app')

  self.type_of_radius_app = attributes[:'type_of_radius_app'] if attributes[:'type_of_radius_app']

  self.end_user_ip_attribute = attributes[:'endUserIPAttribute'] if attributes[:'endUserIPAttribute']

  raise 'You cannot provide both :endUserIPAttribute and :end_user_ip_attribute' if attributes.key?(:'endUserIPAttribute') && attributes.key?(:'end_user_ip_attribute')

  self.end_user_ip_attribute = attributes[:'end_user_ip_attribute'] if attributes[:'end_user_ip_attribute']

  self.radius_vendor_specific_id = attributes[:'radiusVendorSpecificId'] if attributes[:'radiusVendorSpecificId']

  raise 'You cannot provide both :radiusVendorSpecificId and :radius_vendor_specific_id' if attributes.key?(:'radiusVendorSpecificId') && attributes.key?(:'radius_vendor_specific_id')

  self.radius_vendor_specific_id = attributes[:'radius_vendor_specific_id'] if attributes[:'radius_vendor_specific_id']

  self.country_code_response_attribute_id = attributes[:'countryCodeResponseAttributeId'] if attributes[:'countryCodeResponseAttributeId']

  raise 'You cannot provide both :countryCodeResponseAttributeId and :country_code_response_attribute_id' if attributes.key?(:'countryCodeResponseAttributeId') && attributes.key?(:'country_code_response_attribute_id')

  self.country_code_response_attribute_id = attributes[:'country_code_response_attribute_id'] if attributes[:'country_code_response_attribute_id']

  self.group_membership_radius_attribute = attributes[:'groupMembershipRadiusAttribute'] if attributes[:'groupMembershipRadiusAttribute']

  raise 'You cannot provide both :groupMembershipRadiusAttribute and :group_membership_radius_attribute' if attributes.key?(:'groupMembershipRadiusAttribute') && attributes.key?(:'group_membership_radius_attribute')

  self.group_membership_radius_attribute = attributes[:'group_membership_radius_attribute'] if attributes[:'group_membership_radius_attribute']

  self.response_format = attributes[:'responseFormat'] if attributes[:'responseFormat']

  raise 'You cannot provide both :responseFormat and :response_format' if attributes.key?(:'responseFormat') && attributes.key?(:'response_format')

  self.response_format = attributes[:'response_format'] if attributes[:'response_format']

  self.response_format_delimiter = attributes[:'responseFormatDelimiter'] if attributes[:'responseFormatDelimiter']

  raise 'You cannot provide both :responseFormatDelimiter and :response_format_delimiter' if attributes.key?(:'responseFormatDelimiter') && attributes.key?(:'response_format_delimiter')

  self.response_format_delimiter = attributes[:'response_format_delimiter'] if attributes[:'response_format_delimiter']

  self.group_name_format = attributes[:'groupNameFormat'] if attributes[:'groupNameFormat']

  raise 'You cannot provide both :groupNameFormat and :group_name_format' if attributes.key?(:'groupNameFormat') && attributes.key?(:'group_name_format')

  self.group_name_format = attributes[:'group_name_format'] if attributes[:'group_name_format']

  self.password_and_otp_together = attributes[:'passwordAndOtpTogether'] unless attributes[:'passwordAndOtpTogether'].nil?

  raise 'You cannot provide both :passwordAndOtpTogether and :password_and_otp_together' if attributes.key?(:'passwordAndOtpTogether') && attributes.key?(:'password_and_otp_together')

  self.password_and_otp_together = attributes[:'password_and_otp_together'] unless attributes[:'password_and_otp_together'].nil?

  self.group_membership_to_return = attributes[:'groupMembershipToReturn'] if attributes[:'groupMembershipToReturn']

  raise 'You cannot provide both :groupMembershipToReturn and :group_membership_to_return' if attributes.key?(:'groupMembershipToReturn') && attributes.key?(:'group_membership_to_return')

  self.group_membership_to_return = attributes[:'group_membership_to_return'] if attributes[:'group_membership_to_return']
end

Instance Attribute Details

#capture_client_ip ⇒ BOOLEAN

If true, capture the client IP address from the RADIUS request packet. IP Address is used for auditing, policy-evaluation and country-code calculation.

Added In: 2205120021

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

Returns:

  • (BOOLEAN) 


99
100
101
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 99

def capture_client_ip
  @capture_client_ip
end

#client_ip ⇒ String

[Required] This is the IP address of the RADIUS Client like Oracle Database server. It can be only IP address and not hostname.

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 24

def client_ip
  @client_ip
end

#country_code_response_attribute_id ⇒ String

Vendor-specific identifier of the attribute in the RADIUS response that will contain the end-user's country code. This is an integer-value in the range 1 to 255

Added In: 2205120021

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


159
160
161
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 159

def country_code_response_attribute_id
  @country_code_response_attribute_id
end

#end_user_ip_attribute ⇒ String

The name of the attribute that contains the Internet Protocol address of the end-user.

Added In: 2205120021

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


129
130
131
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 129

def end_user_ip_attribute
  @end_user_ip_attribute
end

#group_membership_radius_attribute ⇒ String

RADIUS attribute that RADIUS-enabled system uses to pass the group membership

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


174
175
176
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 174

def group_membership_radius_attribute
  @group_membership_radius_attribute
end

#group_membership_to_return ⇒ Array<OCI::IdentityDomains::Models::AppGroupMembershipToReturn>

In a successful authentication response, Oracle Identity Cloud Service will pass user's group information restricted to groups persisted in this attribute, in the specified RADIUS attribute.

Added In: 20.1.3

SCIM++ Properties: - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Returns:



249
250
251
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 249

def group_membership_to_return
  @group_membership_to_return
end

#group_name_format ⇒ String

Configure the groupNameFormat based on vendor in order to pass it to RADIUS infra

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


219
220
221
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 219

def group_name_format
  @group_name_format
end

#include_group_in_response ⇒ BOOLEAN

[Required] Indicates to include groups in RADIUS response

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean

Returns:

  • (BOOLEAN) 


85
86
87
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 85

def include_group_in_response
  @include_group_in_response
end

#password_and_otp_together ⇒ BOOLEAN

Indicates if password and OTP are passed in the same sign-in request or not.

Added In: 2205120021

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

Returns:

  • (BOOLEAN) 


233
234
235
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 233

def password_and_otp_together
  @password_and_otp_together
end

#port ⇒ String

[Required] This is the port of RADIUS Proxy which RADIUS client will connect to.

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 39

def port
  @port
end

#radius_vendor_specific_id ⇒ String

ID used to identify a particular vendor.

Added In: 2205120021

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


144
145
146
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 144

def radius_vendor_specific_id
  @radius_vendor_specific_id
end

#response_format ⇒ String

Configure the responseFormat based on vendor in order to pass it to RADIUS infra

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


189
190
191
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 189

def response_format
  @response_format
end

#response_format_delimiter ⇒ String

The delimiter used if group membership responseFormat is a delimited list instead of repeating attributes

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


204
205
206
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 204

def response_format_delimiter
  @response_format_delimiter
end

#secret_key ⇒ String

[Required] Secret key used to secure communication between RADIUS Proxy and RADIUS client

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 54

def secret_key
  @secret_key
end

#secret_key_temporary ⇒ String

Secret key used to secure communication between RADIUS Proxy and RADIUS client. This will be available only for few releases for an internal migration requirement. Use secretKey attribute instead of this attribute for all other requirements.

Added In: 2306131901

SCIM++ Properties: - caseExact: true - idcsSearchable: false - idcsSensitive: encrypt - multiValued: false - mutability: readWrite - required: false - returned: never - type: string

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 70

def secret_key_temporary
  @secret_key_temporary
end

#type_of_radius_app ⇒ String

Value consists of type of RADIUS App. Type can be Oracle Database, VPN etc

Added In: 2205120021

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 114

def type_of_radius_app
  @type_of_radius_app
end

Class Method Details

.attribute_map ⇒ Object

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 252

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'client_ip': :'clientIP',
    'port': :'port',
    'secret_key': :'secretKey',
    'secret_key_temporary': :'secretKeyTemporary',
    'include_group_in_response': :'includeGroupInResponse',
    'capture_client_ip': :'captureClientIp',
    'type_of_radius_app': :'typeOfRadiusApp',
    'end_user_ip_attribute': :'endUserIPAttribute',
    'radius_vendor_specific_id': :'radiusVendorSpecificId',
    'country_code_response_attribute_id': :'countryCodeResponseAttributeId',
    'group_membership_radius_attribute': :'groupMembershipRadiusAttribute',
    'response_format': :'responseFormat',
    'response_format_delimiter': :'responseFormatDelimiter',
    'group_name_format': :'groupNameFormat',
    'password_and_otp_together': :'passwordAndOtpTogether',
    'group_membership_to_return': :'groupMembershipToReturn'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 276

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'client_ip': :'String',
    'port': :'String',
    'secret_key': :'String',
    'secret_key_temporary': :'String',
    'include_group_in_response': :'BOOLEAN',
    'capture_client_ip': :'BOOLEAN',
    'type_of_radius_app': :'String',
    'end_user_ip_attribute': :'String',
    'radius_vendor_specific_id': :'String',
    'country_code_response_attribute_id': :'String',
    'group_membership_radius_attribute': :'String',
    'response_format': :'String',
    'response_format_delimiter': :'String',
    'group_name_format': :'String',
    'password_and_otp_together': :'BOOLEAN',
    'group_membership_to_return': :'Array<OCI::IdentityDomains::Models::AppGroupMembershipToReturn>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 427

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    client_ip == other.client_ip &&
    port == other.port &&
    secret_key == other.secret_key &&
    secret_key_temporary == other.secret_key_temporary &&
    include_group_in_response == other.include_group_in_response &&
    capture_client_ip == other.capture_client_ip &&
    type_of_radius_app == other.type_of_radius_app &&
    end_user_ip_attribute == other.end_user_ip_attribute &&
    radius_vendor_specific_id == other.radius_vendor_specific_id &&
    country_code_response_attribute_id == other.country_code_response_attribute_id &&
    group_membership_radius_attribute == other.group_membership_radius_attribute &&
    response_format == other.response_format &&
    response_format_delimiter == other.response_format_delimiter &&
    group_name_format == other.group_name_format &&
    password_and_otp_together == other.password_and_otp_together &&
    group_membership_to_return == other.group_membership_to_return
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



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 472

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


452
453
454
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 452

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



461
462
463
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 461

def hash
  [client_ip, port, secret_key, secret_key_temporary, include_group_in_response, capture_client_ip, type_of_radius_app, end_user_ip_attribute, radius_vendor_specific_id, country_code_response_attribute_id, group_membership_radius_attribute, response_format, response_format_delimiter, group_name_format, password_and_otp_together, group_membership_to_return].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



505
506
507
508
509
510
511
512
513
514
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 505

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



499
500
501
 
# File 'lib/oci/identity_domains/models/app_extension_radius_app_app.rb', line 499

def to_s
  to_hash.to_s
end