Class: OCI::IdentityDomains::Models::ExtensionSocialIdentityProvider

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

Overview

Social Identity Provider Extension Schema

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_CREATED = 'created'.freeze,
  STATUS_DELETED = 'deleted'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionSocialIdentityProvider

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 363

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. = attributes[:'accountLinkingEnabled'] unless attributes[:'accountLinkingEnabled'].nil?

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

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

  self.registration_enabled = attributes[:'registrationEnabled'] unless attributes[:'registrationEnabled'].nil?

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

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

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

  self.authz_url = attributes[:'authzUrl'] if attributes[:'authzUrl']

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

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

  self.access_token_url = attributes[:'accessTokenUrl'] if attributes[:'accessTokenUrl']

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

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

  self.relay_idp_param_mappings = attributes[:'relayIdpParamMappings'] if attributes[:'relayIdpParamMappings']

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

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

  self.profile_url = attributes[:'profileUrl'] if attributes[:'profileUrl']

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

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

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

  self.admin_scope = attributes[:'adminScope'] if attributes[:'adminScope']

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

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

  self.consumer_key = attributes[:'consumerKey'] if attributes[:'consumerKey']

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

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

  self.consumer_secret = attributes[:'consumerSecret'] if attributes[:'consumerSecret']

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

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

  self.service_provider_name = attributes[:'serviceProviderName'] if attributes[:'serviceProviderName']

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

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

  self.clock_skew_in_seconds = attributes[:'clockSkewInSeconds'] if attributes[:'clockSkewInSeconds']

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

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

  self.redirect_url = attributes[:'redirectUrl'] if attributes[:'redirectUrl']

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

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

  self.discovery_url = attributes[:'discoveryUrl'] if attributes[:'discoveryUrl']

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

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

  self.client_credential_in_payload = attributes[:'clientCredentialInPayload'] unless attributes[:'clientCredentialInPayload'].nil?

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

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

  self.id_attribute = attributes[:'idAttribute'] if attributes[:'idAttribute']

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

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

Instance Attribute Details

#access_token_url ⇒ String

Social IDP Access token URL

Added In: 20.1.3

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

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 96

def access_token_url
  @access_token_url
end

#account_linking_enabled ⇒ BOOLEAN

[Required] Whether account linking is enabled

Added In: 20.1.3

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

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 32

def 
  @account_linking_enabled
end

#admin_scope ⇒ Array<String>

Admin scope to request

Added In: 20.1.3

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

Returns:

  • (Array<String>) 


160
161
162
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 160

def admin_scope
  @admin_scope
end

#authz_url ⇒ String

Social IDP Authorization URL

Added In: 20.1.3

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

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 80

def authz_url
  @authz_url
end

#client_credential_in_payload ⇒ BOOLEAN

Whether the client credential is contained in payload

Added In: 20.1.3

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

Returns:

  • (BOOLEAN) 


272
273
274
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 272

def client_credential_in_payload
  @client_credential_in_payload
end

#clock_skew_in_seconds ⇒ Integer

Social IDP allowed clock skew time

Added In: 20.1.3

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

Returns:

  • (Integer) 


224
225
226
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 224

def clock_skew_in_seconds
  @clock_skew_in_seconds
end

#consumer_key ⇒ String

[Required] Social IDP Client Application Client ID

Added In: 20.1.3

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

Returns:

  • (String) 


176
177
178
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 176

def consumer_key
  @consumer_key
end

#consumer_secret ⇒ String

[Required] Social IDP Client Application Client Secret

Added In: 20.1.3

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

Returns:

  • (String) 


193
194
195
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 193

def consumer_secret
  @consumer_secret
end

#discovery_url ⇒ String

Discovery URL

Added In: 20.1.3

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

Returns:

  • (String) 


256
257
258
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 256

def discovery_url
  @discovery_url
end

#id_attribute ⇒ String

Id attribute used for account linking

Added In: 20.1.3

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

Returns:

  • (String) 


288
289
290
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 288

def id_attribute
  @id_attribute
end

#profile_url ⇒ String

Social IDP User profile URL

Added In: 20.1.3

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

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 128

def profile_url
  @profile_url
end

#redirect_url ⇒ String

redirect URL for social idp

Added In: 20.1.3

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

Returns:

  • (String) 


240
241
242
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 240

def redirect_url
  @redirect_url
end

#registration_enabled ⇒ BOOLEAN

[Required] Whether registration is enabled

Added In: 20.1.3

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

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 48

def registration_enabled
  @registration_enabled
end

#relay_idp_param_mappings ⇒ Array<OCI::IdentityDomains::Models::IdentityProviderRelayIdpParamMappings>

Relay Param variable for Social IDP

Added In: 2305190132

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

Returns:



112
113
114
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 112

def relay_idp_param_mappings
  @relay_idp_param_mappings
end

#scope ⇒ Array<String>

Scope to request

Added In: 20.1.3

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

Returns:

  • (Array<String>) 


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

def scope
  @scope
end

#service_provider_name ⇒ String

[Required] Service Provider Name

Added In: 20.1.3

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

Returns:

  • (String) 


209
210
211
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 209

def service_provider_name
  @service_provider_name
end

#status ⇒ String

Status

Added In: 20.1.3

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

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 64

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 291

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'account_linking_enabled': :'accountLinkingEnabled',
    'registration_enabled': :'registrationEnabled',
    'status': :'status',
    'authz_url': :'authzUrl',
    'access_token_url': :'accessTokenUrl',
    'relay_idp_param_mappings': :'relayIdpParamMappings',
    'profile_url': :'profileUrl',
    'scope': :'scope',
    'admin_scope': :'adminScope',
    'consumer_key': :'consumerKey',
    'consumer_secret': :'consumerSecret',
    'service_provider_name': :'serviceProviderName',
    'clock_skew_in_seconds': :'clockSkewInSeconds',
    'redirect_url': :'redirectUrl',
    'discovery_url': :'discoveryUrl',
    'client_credential_in_payload': :'clientCredentialInPayload',
    'id_attribute': :'idAttribute'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 316

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'account_linking_enabled': :'BOOLEAN',
    'registration_enabled': :'BOOLEAN',
    'status': :'String',
    'authz_url': :'String',
    'access_token_url': :'String',
    'relay_idp_param_mappings': :'Array<OCI::IdentityDomains::Models::IdentityProviderRelayIdpParamMappings>',
    'profile_url': :'String',
    'scope': :'Array<String>',
    'admin_scope': :'Array<String>',
    'consumer_key': :'String',
    'consumer_secret': :'String',
    'service_provider_name': :'String',
    'clock_skew_in_seconds': :'Integer',
    'redirect_url': :'String',
    'discovery_url': :'String',
    'client_credential_in_payload': :'BOOLEAN',
    'id_attribute': :'String'
    # 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



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 484

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

  self.class == other.class &&
     == other. &&
    registration_enabled == other.registration_enabled &&
    status == other.status &&
    authz_url == other.authz_url &&
    access_token_url == other.access_token_url &&
    relay_idp_param_mappings == other.relay_idp_param_mappings &&
    profile_url == other.profile_url &&
    scope == other.scope &&
    admin_scope == other.admin_scope &&
    consumer_key == other.consumer_key &&
    consumer_secret == other.consumer_secret &&
    service_provider_name == other.service_provider_name &&
    clock_skew_in_seconds == other.clock_skew_in_seconds &&
    redirect_url == other.redirect_url &&
    discovery_url == other.discovery_url &&
    client_credential_in_payload == other.client_credential_in_payload &&
    id_attribute == other.id_attribute
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



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 530

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


510
511
512
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 510

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



519
520
521
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 519

def hash
  [, registration_enabled, status, authz_url, access_token_url, relay_idp_param_mappings, profile_url, scope, admin_scope, consumer_key, consumer_secret, service_provider_name, clock_skew_in_seconds, redirect_url, discovery_url, client_credential_in_payload, id_attribute].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



563
564
565
566
567
568
569
570
571
572
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 563

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



557
558
559
 
# File 'lib/oci/identity_domains/models/extension_social_identity_provider.rb', line 557

def to_s
  to_hash.to_s
end