Class: OCI::IdentityDomains::Models::AppExtensionSamlServiceProviderApp

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

Overview

This extension defines attributes related to the Service Providers configuration.

Constant Summary collapse

ENCRYPTION_ALGORITHM_ENUM = 
[
  ENCRYPTION_ALGORITHM_3_DES = '3DES'.freeze,
  ENCRYPTION_ALGORITHM_AES_128 = 'AES-128'.freeze,
  ENCRYPTION_ALGORITHM_AES_256 = 'AES-256'.freeze,
  ENCRYPTION_ALGORITHM_AES_192 = 'AES-192'.freeze,
  ENCRYPTION_ALGORITHM_AES_128_GCM = 'AES-128-GCM'.freeze,
  ENCRYPTION_ALGORITHM_AES_256_GCM = 'AES-256-GCM'.freeze,
  ENCRYPTION_ALGORITHM_AES_192_GCM = 'AES-192-GCM'.freeze,
  ENCRYPTION_ALGORITHM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
KEY_ENCRYPTION_ALGORITHM_ENUM = 
[
  KEY_ENCRYPTION_ALGORITHM_RSA_V1_5 = 'RSA-v1.5'.freeze,
  KEY_ENCRYPTION_ALGORITHM_RSA_OAEP = 'RSA-OAEP'.freeze,
  KEY_ENCRYPTION_ALGORITHM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SIGN_RESPONSE_OR_ASSERTION_ENUM = 
[
  SIGN_RESPONSE_OR_ASSERTION_ASSERTION = 'Assertion'.freeze,
  SIGN_RESPONSE_OR_ASSERTION_RESPONSE = 'Response'.freeze,
  SIGN_RESPONSE_OR_ASSERTION_ASSERTION_AND_RESPONSE = 'AssertionAndResponse'.freeze,
  SIGN_RESPONSE_OR_ASSERTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LOGOUT_BINDING_ENUM = 
[
  LOGOUT_BINDING_REDIRECT = 'Redirect'.freeze,
  LOGOUT_BINDING_POST = 'Post'.freeze,
  LOGOUT_BINDING_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SIGNATURE_HASH_ALGORITHM_ENUM = 
[
  SIGNATURE_HASH_ALGORITHM_SHA_1 = 'SHA-1'.freeze,
  SIGNATURE_HASH_ALGORITHM_SHA_256 = 'SHA-256'.freeze,
  SIGNATURE_HASH_ALGORITHM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FEDERATION_PROTOCOL_ENUM = 
[
  FEDERATION_PROTOCOL_SAML2_0 = 'SAML2.0'.freeze,
  FEDERATION_PROTOCOL_WS_FED1_1 = 'WS-Fed1.1'.freeze,
  FEDERATION_PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppExtensionSamlServiceProviderApp

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 542

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.metadata = attributes[:'metadata'] if attributes[:'metadata']

  self.partner_provider_id = attributes[:'partnerProviderId'] if attributes[:'partnerProviderId']

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

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

  self.partner_provider_pattern = attributes[:'partnerProviderPattern'] if attributes[:'partnerProviderPattern']

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

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

  self.tenant_provider_id = attributes[:'tenantProviderId'] if attributes[:'tenantProviderId']

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

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

  self.succinct_id = attributes[:'succinctId'] if attributes[:'succinctId']

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

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

  self.assertion_consumer_url = attributes[:'assertionConsumerUrl'] if attributes[:'assertionConsumerUrl']

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

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

  self.logout_request_url = attributes[:'logoutRequestUrl'] if attributes[:'logoutRequestUrl']

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

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

  self.logout_response_url = attributes[:'logoutResponseUrl'] if attributes[:'logoutResponseUrl']

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

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

  self.name_id_format = attributes[:'nameIdFormat'] if attributes[:'nameIdFormat']

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

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

  self.signing_certificate = attributes[:'signingCertificate'] if attributes[:'signingCertificate']

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

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

  self.encryption_certificate = attributes[:'encryptionCertificate'] if attributes[:'encryptionCertificate']

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

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

  self.encryption_algorithm = attributes[:'encryptionAlgorithm'] if attributes[:'encryptionAlgorithm']

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

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

  self.key_encryption_algorithm = attributes[:'keyEncryptionAlgorithm'] if attributes[:'keyEncryptionAlgorithm']

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

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

  self.encrypt_assertion = attributes[:'encryptAssertion'] unless attributes[:'encryptAssertion'].nil?

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

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

  self.sign_response_or_assertion = attributes[:'signResponseOrAssertion'] if attributes[:'signResponseOrAssertion']

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

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

  self.include_signing_cert_in_signature = attributes[:'includeSigningCertInSignature'] unless attributes[:'includeSigningCertInSignature'].nil?

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

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

  self.logout_binding = attributes[:'logoutBinding'] if attributes[:'logoutBinding']

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

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

  self.logout_enabled = attributes[:'logoutEnabled'] unless attributes[:'logoutEnabled'].nil?

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

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

  self.signature_hash_algorithm = attributes[:'signatureHashAlgorithm'] if attributes[:'signatureHashAlgorithm']

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

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

  self.federation_protocol = attributes[:'federationProtocol'] if attributes[:'federationProtocol']

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

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

  self.name_id_userstore_attribute = attributes[:'nameIdUserstoreAttribute'] if attributes[:'nameIdUserstoreAttribute']

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

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

  self.hok_required = attributes[:'hokRequired'] unless attributes[:'hokRequired'].nil?

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

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

  self.hok_acs_url = attributes[:'hokAcsUrl'] if attributes[:'hokAcsUrl']

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

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

  self.last_notification_sent_time = attributes[:'lastNotificationSentTime'] if attributes[:'lastNotificationSentTime']

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

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

  self.outbound_assertion_attributes = attributes[:'outboundAssertionAttributes'] if attributes[:'outboundAssertionAttributes']

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

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

  self.user_assertion_attributes = attributes[:'userAssertionAttributes'] if attributes[:'userAssertionAttributes']

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

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

  self.group_assertion_attributes = attributes[:'groupAssertionAttributes'] if attributes[:'groupAssertionAttributes']

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

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

Instance Attribute Details

#assertion_consumer_url ⇒ String

The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP.

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

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 139

def assertion_consumer_url
  @assertion_consumer_url
end

#encrypt_assertion ⇒ BOOLEAN

If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion.

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

Returns:

  • (BOOLEAN) 


250
251
252
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 250

def encrypt_assertion
  @encrypt_assertion
end

#encryption_algorithm ⇒ String

This attribute indicates the encryption algorithm used to encrypt the SAML assertion.

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

Returns:

  • (String) 


221
222
223
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 221

def encryption_algorithm
  @encryption_algorithm
end

#encryption_certificate ⇒ String

This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion.

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

Returns:

  • (String) 


207
208
209
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 207

def encryption_certificate
  @encryption_certificate
end

#federation_protocol ⇒ String

Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1).

Added In: 18.2.6

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

Returns:

  • (String) 


335
336
337
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 335

def federation_protocol
  @federation_protocol
end

#group_assertion_attributes ⇒ Array<OCI::IdentityDomains::Models::AppGroupAssertionAttributes>

Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion.

Deprecated Since: 18.2.2

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

Returns:



437
438
439
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 437

def group_assertion_attributes
  @group_assertion_attributes
end

#hok_acs_url ⇒ String

Hok Assertion Consumer Service Url

Added In: 2101262133

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

Returns:

  • (String) 


382
383
384
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 382

def hok_acs_url
  @hok_acs_url
end

#hok_required ⇒ BOOLEAN

If enabled, then the SAML Service supports Hok for this App.

Added In: 2101262133

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

Returns:

  • (BOOLEAN) 


366
367
368
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 366

def hok_required
  @hok_required
end

#include_signing_cert_in_signature ⇒ BOOLEAN

If true, then the signing certificate is included in the signature.

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

Returns:

  • (BOOLEAN) 


277
278
279
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 277

def include_signing_cert_in_signature
  @include_signing_cert_in_signature
end

#key_encryption_algorithm ⇒ String

This attribute indicates the key encryption algorithm.

Added In: 18.4.2

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

Returns:

  • (String) 


237
238
239
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 237

def key_encryption_algorithm
  @key_encryption_algorithm
end

#last_notification_sent_time ⇒ String

Records the notification timestamp for the SP whose signing certificate is about to expire.

Added In: 2302092332

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: dateTime - uniqueness: none

Returns:

  • (String) 


398
399
400
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 398

def last_notification_sent_time
  @last_notification_sent_time
end

#logout_binding ⇒ String

This attribute represents the HTTP binding that would be used while logout.

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

Returns:

  • (String) 


291
292
293
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 291

def logout_binding
  @logout_binding
end

#logout_enabled ⇒ BOOLEAN

If true, then the SAML Service supports logout for this App.

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

Returns:

  • (BOOLEAN) 


304
305
306
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 304

def logout_enabled
  @logout_enabled
end

#logout_request_url ⇒ String

The URL to which the partner sends the logout request.

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

Returns:

  • (String) 


153
154
155
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 153

def logout_request_url
  @logout_request_url
end

#logout_response_url ⇒ String

The URL to which the partner sends the logout response.

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

Returns:

  • (String) 


167
168
169
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 167

def logout_response_url
  @logout_response_url
end

#metadata ⇒ String

This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol.

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

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 65

def metadata
  @metadata
end

#name_id_format ⇒ String

This can be any string, but there are a set of standard nameIdFormats. If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque.

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

Returns:

  • (String) 


181
182
183
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 181

def name_id_format
  @name_id_format
end

#name_id_userstore_attribute ⇒ String

Deprecated Since: 18.2.2

SCIM++ Properties: - caseExact: false - idcsSearchable: true - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none This property specifies which user attribute is used as the NameID value in the SAML assertion. This attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.

Returns:

  • (String) 


351
352
353
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 351

def name_id_userstore_attribute
  @name_id_userstore_attribute
end

#outbound_assertion_attributes ⇒ OCI::IdentityDomains::Models::AppOutboundAssertionAttributes

Returns:



401
402
403
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 401

def outbound_assertion_attributes
  @outbound_assertion_attributes
end

#partner_provider_id ⇒ String

The ID of the Provider. This value corresponds to the entityID from the Service Provider metadata.

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

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 79

def partner_provider_id
  @partner_provider_id
end

#partner_provider_pattern ⇒ String

The pattern of the Provider. This value corresponds to the entityID from the Service Provider metadata.

Added In: 2202230830

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

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 95

def partner_provider_pattern
  @partner_provider_pattern
end

#sign_response_or_assertion ⇒ String

Indicates which part of the response should be signed. A value of \“Assertion\” indicates that the Assertion should be signed. A value of \“Response\” indicates that the SSO Response should be signed. A value of \“AssertionAndResponse\” indicates that both the Assertion and the SSO Response should be signed.

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

Returns:

  • (String) 


264
265
266
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 264

def sign_response_or_assertion
  @sign_response_or_assertion
end

#signature_hash_algorithm ⇒ String

This attribute represents the algorithm used to hash the signature.

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

Returns:

  • (String) 


318
319
320
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 318

def signature_hash_algorithm
  @signature_hash_algorithm
end

#signing_certificate ⇒ String

This attribute represents the signing certificate that an App uses to verify the signed authentication request.

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

Returns:

  • (String) 


194
195
196
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 194

def signing_certificate
  @signing_certificate
end

#succinct_id ⇒ String

This attribute represents the Succinct ID.

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

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 125

def succinct_id
  @succinct_id
end

#tenant_provider_id ⇒ String

The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP.

Added In: 19.2.1

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

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 111

def tenant_provider_id
  @tenant_provider_id
end

#user_assertion_attributes ⇒ Array<OCI::IdentityDomains::Models::AppUserAssertionAttributes>

Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion.

Deprecated Since: 18.2.2

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

Returns:



419
420
421
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 419

def user_assertion_attributes
  @user_assertion_attributes
end

Class Method Details

.attribute_map ⇒ Object

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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 440

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metadata': :'metadata',
    'partner_provider_id': :'partnerProviderId',
    'partner_provider_pattern': :'partnerProviderPattern',
    'tenant_provider_id': :'tenantProviderId',
    'succinct_id': :'succinctId',
    'assertion_consumer_url': :'assertionConsumerUrl',
    'logout_request_url': :'logoutRequestUrl',
    'logout_response_url': :'logoutResponseUrl',
    'name_id_format': :'nameIdFormat',
    'signing_certificate': :'signingCertificate',
    'encryption_certificate': :'encryptionCertificate',
    'encryption_algorithm': :'encryptionAlgorithm',
    'key_encryption_algorithm': :'keyEncryptionAlgorithm',
    'encrypt_assertion': :'encryptAssertion',
    'sign_response_or_assertion': :'signResponseOrAssertion',
    'include_signing_cert_in_signature': :'includeSigningCertInSignature',
    'logout_binding': :'logoutBinding',
    'logout_enabled': :'logoutEnabled',
    'signature_hash_algorithm': :'signatureHashAlgorithm',
    'federation_protocol': :'federationProtocol',
    'name_id_userstore_attribute': :'nameIdUserstoreAttribute',
    'hok_required': :'hokRequired',
    'hok_acs_url': :'hokAcsUrl',
    'last_notification_sent_time': :'lastNotificationSentTime',
    'outbound_assertion_attributes': :'outboundAssertionAttributes',
    'user_assertion_attributes': :'userAssertionAttributes',
    'group_assertion_attributes': :'groupAssertionAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 475

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metadata': :'String',
    'partner_provider_id': :'String',
    'partner_provider_pattern': :'String',
    'tenant_provider_id': :'String',
    'succinct_id': :'String',
    'assertion_consumer_url': :'String',
    'logout_request_url': :'String',
    'logout_response_url': :'String',
    'name_id_format': :'String',
    'signing_certificate': :'String',
    'encryption_certificate': :'String',
    'encryption_algorithm': :'String',
    'key_encryption_algorithm': :'String',
    'encrypt_assertion': :'BOOLEAN',
    'sign_response_or_assertion': :'String',
    'include_signing_cert_in_signature': :'BOOLEAN',
    'logout_binding': :'String',
    'logout_enabled': :'BOOLEAN',
    'signature_hash_algorithm': :'String',
    'federation_protocol': :'String',
    'name_id_userstore_attribute': :'String',
    'hok_required': :'BOOLEAN',
    'hok_acs_url': :'String',
    'last_notification_sent_time': :'String',
    'outbound_assertion_attributes': :'OCI::IdentityDomains::Models::AppOutboundAssertionAttributes',
    'user_assertion_attributes': :'Array<OCI::IdentityDomains::Models::AppUserAssertionAttributes>',
    'group_assertion_attributes': :'Array<OCI::IdentityDomains::Models::AppGroupAssertionAttributes>'
    # 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



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 792

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

  self.class == other.class &&
    metadata == other.metadata &&
    partner_provider_id == other.partner_provider_id &&
    partner_provider_pattern == other.partner_provider_pattern &&
    tenant_provider_id == other.tenant_provider_id &&
    succinct_id == other.succinct_id &&
    assertion_consumer_url == other.assertion_consumer_url &&
    logout_request_url == other.logout_request_url &&
    logout_response_url == other.logout_response_url &&
    name_id_format == other.name_id_format &&
    signing_certificate == other.signing_certificate &&
    encryption_certificate == other.encryption_certificate &&
    encryption_algorithm == other.encryption_algorithm &&
    key_encryption_algorithm == other.key_encryption_algorithm &&
    encrypt_assertion == other.encrypt_assertion &&
    sign_response_or_assertion == other.sign_response_or_assertion &&
    include_signing_cert_in_signature == other.include_signing_cert_in_signature &&
    logout_binding == other.logout_binding &&
    logout_enabled == other.logout_enabled &&
    signature_hash_algorithm == other.signature_hash_algorithm &&
    federation_protocol == other.federation_protocol &&
    name_id_userstore_attribute == other.name_id_userstore_attribute &&
    hok_required == other.hok_required &&
    hok_acs_url == other.hok_acs_url &&
    last_notification_sent_time == other.last_notification_sent_time &&
    outbound_assertion_attributes == other.outbound_assertion_attributes &&
    user_assertion_attributes == other.user_assertion_attributes &&
    group_assertion_attributes == other.group_assertion_attributes
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



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 848

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


828
829
830
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 828

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



837
838
839
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 837

def hash
  [metadata, partner_provider_id, partner_provider_pattern, tenant_provider_id, succinct_id, assertion_consumer_url, logout_request_url, logout_response_url, name_id_format, signing_certificate, encryption_certificate, encryption_algorithm, key_encryption_algorithm, encrypt_assertion, sign_response_or_assertion, include_signing_cert_in_signature, logout_binding, logout_enabled, signature_hash_algorithm, federation_protocol, name_id_userstore_attribute, hok_required, hok_acs_url, last_notification_sent_time, outbound_assertion_attributes, user_assertion_attributes, group_assertion_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



881
882
883
884
885
886
887
888
889
890
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 881

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



875
876
877
 
# File 'lib/oci/identity_domains/models/app_extension_saml_service_provider_app.rb', line 875

def to_s
  to_hash.to_s
end