Class: OCI::IdentityDomains::Models::SocialIdentityProvider

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

Overview

Social Identity Provider

Constant Summary collapse

IDCS_PREVENTED_OPERATIONS_ENUM = 
[
  IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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 = {}) ⇒ SocialIdentityProvider

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
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
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 713

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

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

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

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

  self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy']

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

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

  self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy']

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

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

  self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations']

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

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

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

  self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil?

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

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

  self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease']

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

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

  self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid']

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

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

  self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid']

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

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

  self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid']

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

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

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

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

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

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

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

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

  self.jit_prov_group_static_list_enabled = attributes[:'jitProvGroupStaticListEnabled'] unless attributes[:'jitProvGroupStaticListEnabled'].nil?

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

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

  self.jit_prov_assigned_groups = attributes[:'jitProvAssignedGroups'] if attributes[:'jitProvAssignedGroups']

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

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

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

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

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

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

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

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

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

  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']

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

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

  self.icon_url = attributes[:'icon_url'] if attributes[:'icon_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.refresh_token_url = attributes[:'refreshTokenUrl'] if attributes[:'refreshTokenUrl']

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

  self.refresh_token_url = attributes[:'refresh_token_url'] if attributes[:'refresh_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']
end

Instance Attribute Details

#access_token_url ⇒ String

Social IDP Access token URL

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

Returns:

  • (String) 


377
378
379
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 377

def access_token_url
  @access_token_url
end

#account_linking_enabled ⇒ BOOLEAN

[Required] Whether account linking is enabled

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

Returns:

  • (BOOLEAN) 


227
228
229
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 227

def 
  @account_linking_enabled
end

#admin_scope ⇒ Array<String>

Admin scope to request

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

Returns:

  • (Array<String>) 


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

def admin_scope
  @admin_scope
end

#authz_url ⇒ String

Social IDP Authorization URL

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

Returns:

  • (String) 


363
364
365
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 363

def authz_url
  @authz_url
end

#auto_redirect_enabled ⇒ BOOLEAN

Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected.

Added In: 2310202314

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

Returns:

  • (BOOLEAN) 


305
306
307
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 305

def auto_redirect_enabled
  @auto_redirect_enabled
end

#client_credential_in_payload ⇒ BOOLEAN

Whether the client credential is contained in payload

Added In: 18.4.2

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

Returns:

  • (BOOLEAN) 


537
538
539
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 537

def client_credential_in_payload
  @client_credential_in_payload
end

#clock_skew_in_seconds ⇒ Integer

Social IDP allowed clock skew time

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

Returns:

  • (Integer) 


475
476
477
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 475

def clock_skew_in_seconds
  @clock_skew_in_seconds
end

#compartment_ocid ⇒ String

OCI Compartment Id (ocid) in which the resource lives.

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

Returns:

  • (String) 


157
158
159
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 157

def compartment_ocid
  @compartment_ocid
end

#consumer_key ⇒ String

[Required] Social IDP Client Application Client ID

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

Returns:

  • (String) 


433
434
435
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 433

def consumer_key
  @consumer_key
end

#consumer_secret ⇒ String

[Required] Social IDP Client Application Client Secret

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

Returns:

  • (String) 


448
449
450
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 448

def consumer_secret
  @consumer_secret
end

#delete_in_progress ⇒ BOOLEAN

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

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

Returns:

  • (BOOLEAN) 


115
116
117
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 115

def delete_in_progress
  @delete_in_progress
end

#description ⇒ String

Social IDP description

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

Returns:

  • (String) 


199
200
201
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 199

def description
  @description
end

#discovery_url ⇒ String

Discovery URL

Added In: 17.4.6

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

Returns:

  • (String) 


521
522
523
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 521

def discovery_url
  @discovery_url
end

#domain_ocid ⇒ String

OCI Domain Id (ocid) in which the resource lives.

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

Returns:

  • (String) 


143
144
145
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 143

def domain_ocid
  @domain_ocid
end

#enabled ⇒ BOOLEAN

[Required] Whether the IDP is enabled or not

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

Returns:

  • (BOOLEAN) 


213
214
215
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 213

def enabled
  @enabled
end

#icon_url ⇒ String

ICON URL for social idp

Added In: 17.4.6

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

Returns:

  • (String) 


505
506
507
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 505

def icon_url
  @icon_url
end

#id ⇒ String

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 37

def id
  @id
end

#id_attribute ⇒ String

Id attribute used for account linking

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

Returns:

  • (String) 


349
350
351
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 349

def id_attribute
  @id_attribute
end

#idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy

Returns:



71
72
73
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 71

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy

Returns:



74
75
76
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 74

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_release ⇒ String

The release number when the resource was upgraded.

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

Returns:

  • (String) 


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

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operations ⇒ Array<String>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

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

Returns:

  • (Array<String>) 


87
88
89
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 87

def idcs_prevented_operations
  @idcs_prevented_operations
end

#jit_prov_assigned_groups ⇒ Array<OCI::IdentityDomains::Models::SocialIdentityProviderJitProvAssignedGroups>

Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true.

Added In: 2309290043

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

Returns:



275
276
277
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 275

def jit_prov_assigned_groups
  @jit_prov_assigned_groups
end

#jit_prov_group_static_list_enabled ⇒ BOOLEAN

Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list

Added In: 2309290043

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

Returns:

  • (BOOLEAN) 


259
260
261
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 259

def jit_prov_group_static_list_enabled
  @jit_prov_group_static_list_enabled
end

#meta ⇒ OCI::IdentityDomains::Models::Meta

Returns:



68
69
70
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 68

def meta
  @meta
end

#name ⇒ String

[Required] Social provider name

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

Returns:

  • (String) 


185
186
187
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 185

def name
  @name
end

#ocid ⇒ String

Unique OCI identifier for the SCIM Resource.

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 51

def ocid
  @ocid
end

#profile_url ⇒ String

Social IDP User profile URL

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

Returns:

  • (String) 


391
392
393
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 391

def profile_url
  @profile_url
end

#redirect_url ⇒ String

redirect URL for social idp

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

Returns:

  • (String) 


489
490
491
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 489

def redirect_url
  @redirect_url
end

#refresh_token_url ⇒ String

Social IDP Refresh token URL

Added In: 19.1.4

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

Returns:

  • (String) 


553
554
555
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 553

def refresh_token_url
  @refresh_token_url
end

#registration_enabled ⇒ BOOLEAN

[Required] Whether registration is enabled

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

Returns:

  • (BOOLEAN) 


289
290
291
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 289

def registration_enabled
  @registration_enabled
end

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

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:



569
570
571
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 569

def relay_idp_param_mappings
  @relay_idp_param_mappings
end

#schemas ⇒ Array<String>

[Required] REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

Returns:

  • (Array<String>) 


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

def schemas
  @schemas
end

#scope ⇒ Array<String>

Scope to request

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

Returns:

  • (Array<String>) 


405
406
407
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 405

def scope
  @scope
end

#service_provider_name ⇒ String

[Required] Service Provider Name

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

Returns:

  • (String) 


462
463
464
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 462

def service_provider_name
  @service_provider_name
end

#show_on_login ⇒ BOOLEAN

[Required] Whether show on login

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

Returns:

  • (BOOLEAN) 


319
320
321
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 319

def 
  @show_on_login
end

#social_jit_provisioning_enabled ⇒ BOOLEAN

Whether Social JIT Provisioning is enabled

Added In: 2307282043

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

Returns:

  • (BOOLEAN) 


243
244
245
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 243

def social_jit_provisioning_enabled
  @social_jit_provisioning_enabled
end

#status ⇒ String

Status

Added In: 17.4.6

SCIM++ Properties: - caseExact: true - 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/social_identity_provider.rb', line 335

def status
  @status
end

#tags ⇒ Array<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

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

Returns:



101
102
103
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 101

def tags
  @tags
end

#tenancy_ocid ⇒ String

OCI Tenant Id (ocid) in which the resource lives.

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

Returns:

  • (String) 


171
172
173
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 171

def tenancy_ocid
  @tenancy_ocid
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 572

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'ocid': :'ocid',
    'schemas': :'schemas',
    'meta': :'meta',
    'idcs_created_by': :'idcsCreatedBy',
    'idcs_last_modified_by': :'idcsLastModifiedBy',
    'idcs_prevented_operations': :'idcsPreventedOperations',
    'tags': :'tags',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'name': :'name',
    'description': :'description',
    'enabled': :'enabled',
    'account_linking_enabled': :'accountLinkingEnabled',
    'social_jit_provisioning_enabled': :'socialJitProvisioningEnabled',
    'jit_prov_group_static_list_enabled': :'jitProvGroupStaticListEnabled',
    'jit_prov_assigned_groups': :'jitProvAssignedGroups',
    'registration_enabled': :'registrationEnabled',
    'auto_redirect_enabled': :'autoRedirectEnabled',
    'show_on_login': :'showOnLogin',
    'status': :'status',
    'id_attribute': :'idAttribute',
    'authz_url': :'authzUrl',
    'access_token_url': :'accessTokenUrl',
    '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',
    'icon_url': :'iconUrl',
    'discovery_url': :'discoveryUrl',
    'client_credential_in_payload': :'clientCredentialInPayload',
    'refresh_token_url': :'refreshTokenUrl',
    'relay_idp_param_mappings': :'relayIdpParamMappings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 620

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'ocid': :'String',
    'schemas': :'Array<String>',
    'meta': :'OCI::IdentityDomains::Models::Meta',
    'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy',
    'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy',
    'idcs_prevented_operations': :'Array<String>',
    'tags': :'Array<OCI::IdentityDomains::Models::Tags>',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'name': :'String',
    'description': :'String',
    'enabled': :'BOOLEAN',
    'account_linking_enabled': :'BOOLEAN',
    'social_jit_provisioning_enabled': :'BOOLEAN',
    'jit_prov_group_static_list_enabled': :'BOOLEAN',
    'jit_prov_assigned_groups': :'Array<OCI::IdentityDomains::Models::SocialIdentityProviderJitProvAssignedGroups>',
    'registration_enabled': :'BOOLEAN',
    'auto_redirect_enabled': :'BOOLEAN',
    'show_on_login': :'BOOLEAN',
    'status': :'String',
    'id_attribute': :'String',
    'authz_url': :'String',
    'access_token_url': :'String',
    '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',
    'icon_url': :'String',
    'discovery_url': :'String',
    'client_credential_in_payload': :'BOOLEAN',
    'refresh_token_url': :'String',
    'relay_idp_param_mappings': :'Array<OCI::IdentityDomains::Models::SocialIdentityProviderRelayIdpParamMappings>'
    # 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



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 960

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

  self.class == other.class &&
    id == other.id &&
    ocid == other.ocid &&
    schemas == other.schemas &&
    meta == other.meta &&
    idcs_created_by == other.idcs_created_by &&
    idcs_last_modified_by == other.idcs_last_modified_by &&
    idcs_prevented_operations == other.idcs_prevented_operations &&
    tags == other.tags &&
    delete_in_progress == other.delete_in_progress &&
    idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release &&
    domain_ocid == other.domain_ocid &&
    compartment_ocid == other.compartment_ocid &&
    tenancy_ocid == other.tenancy_ocid &&
    name == other.name &&
    description == other.description &&
    enabled == other.enabled &&
     == other. &&
    social_jit_provisioning_enabled == other.social_jit_provisioning_enabled &&
    jit_prov_group_static_list_enabled == other.jit_prov_group_static_list_enabled &&
    jit_prov_assigned_groups == other.jit_prov_assigned_groups &&
    registration_enabled == other.registration_enabled &&
    auto_redirect_enabled == other.auto_redirect_enabled &&
     == other. &&
    status == other.status &&
    id_attribute == other.id_attribute &&
    authz_url == other.authz_url &&
    access_token_url == other.access_token_url &&
    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 &&
    icon_url == other.icon_url &&
    discovery_url == other.discovery_url &&
    client_credential_in_payload == other.client_credential_in_payload &&
    refresh_token_url == other.refresh_token_url &&
    relay_idp_param_mappings == other.relay_idp_param_mappings
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



1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 1029

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


1009
1010
1011
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 1009

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1018
1019
1020
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 1018

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, name, description, enabled, , social_jit_provisioning_enabled, jit_prov_group_static_list_enabled, jit_prov_assigned_groups, registration_enabled, auto_redirect_enabled, , status, id_attribute, authz_url, access_token_url, profile_url, scope, admin_scope, consumer_key, consumer_secret, service_provider_name, clock_skew_in_seconds, redirect_url, icon_url, discovery_url, client_credential_in_payload, refresh_token_url, relay_idp_param_mappings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 1062

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



1056
1057
1058
 
# File 'lib/oci/identity_domains/models/social_identity_provider.rb', line 1056

def to_s
  to_hash.to_s
end