Class: OCI::IdentityDomains::Models::SelfRegistrationProfile

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

Overview

Self Registration Profile

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SelfRegistrationProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 553

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

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

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

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

  self.activation_email_required = attributes[:'activationEmailRequired'] unless attributes[:'activationEmailRequired'].nil?

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

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

  self.number_of_days_redirect_url_is_valid = attributes[:'numberOfDaysRedirectUrlIsValid'] if attributes[:'numberOfDaysRedirectUrlIsValid']

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

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

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

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

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

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

  self.allowed_email_domains = attributes[:'allowedEmailDomains'] if attributes[:'allowedEmailDomains']

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

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

  self.disallowed_email_domains = attributes[:'disallowedEmailDomains'] if attributes[:'disallowedEmailDomains']

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

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

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

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

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

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

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

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

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.after_submit_text = attributes[:'afterSubmitText'] if attributes[:'afterSubmitText']

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

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

  self.user_attributes = attributes[:'userAttributes'] if attributes[:'userAttributes']

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

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

  self.email_template = attributes[:'emailTemplate'] if attributes[:'emailTemplate']

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

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

  self.default_groups = attributes[:'defaultGroups'] if attributes[:'defaultGroups']

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

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

  self.header_text = attributes[:'headerText'] if attributes[:'headerText']

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

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

  self.footer_text = attributes[:'footerText'] if attributes[:'footerText']

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

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

  self.consent_text = attributes[:'consentText'] if attributes[:'consentText']

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

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

Instance Attribute Details

#activation_email_required ⇒ BOOLEAN

[Required] SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none A Boolean value that indicates whether Account verification email is required to be sent before login or not

Returns:

  • (BOOLEAN) 


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

def activation_email_required
  @activation_email_required
end

#active ⇒ BOOLEAN

A Boolean value that indicates whether the profile is enabled or not

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

Returns:

  • (BOOLEAN) 


231
232
233
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 231

def active
  @active
end

#after_submit_text ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileAfterSubmitText>

Text to be displayed on UI after doing self registration

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

Returns:



355
356
357
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 355

def after_submit_text
  @after_submit_text
end

#allowed_email_domains ⇒ Array<String>

A Multivalue String value for Email domains which are valid for this profile

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

Returns:

  • (Array<String>) 


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

def allowed_email_domains
  @allowed_email_domains
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) 


151
152
153
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 151

def compartment_ocid
  @compartment_ocid
end

#consent_text ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileConsentText>

Consent text

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

Returns:



430
431
432
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 430

def consent_text
  @consent_text
end

#consent_text_present ⇒ BOOLEAN

[Required] A boolean value that indicates whether the consent text is present.

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

Returns:

  • (BOOLEAN) 


325
326
327
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 325

def consent_text_present
  @consent_text_present
end

#default_groups ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileDefaultGroups>

Default groups assigned to the user

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

Returns:



385
386
387
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 385

def default_groups
  @default_groups
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) 


109
110
111
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 109

def delete_in_progress
  @delete_in_progress
end

#disallowed_email_domains ⇒ Array<String>

A Multivalue String Value for Email domains to be handled as exceptions

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

Returns:

  • (Array<String>) 


273
274
275
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 273

def disallowed_email_domains
  @disallowed_email_domains
end

#display_name ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileDisplayName>

[Required] Registration page name

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

Returns:



340
341
342
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 340

def display_name
  @display_name
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) 


137
138
139
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 137

def domain_ocid
  @domain_ocid
end

#email_template ⇒ OCI::IdentityDomains::Models::SelfRegistrationProfileEmailTemplate

This attribute is required.

Returns:



372
373
374
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 372

def email_template
  @email_template
end

#external_id ⇒ String

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.

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

Returns:

  • (String) 


177
178
179
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 177

def external_id
  @external_id
end

#footer_logo ⇒ String

References to footer logo

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

Returns:

  • (String) 


297
298
299
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 297

def 
  @footer_logo
end

#footer_text ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileFooterText>

Footer text

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

Returns:



415
416
417
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 415

def footer_text
  @footer_text
end

#header_logo ⇒ String

Reference to header logo

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

Returns:

  • (String) 


285
286
287
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 285

def 
  @header_logo
end

#header_text ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileHeaderText>

Header text

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

Returns:



400
401
402
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 400

def header_text
  @header_text
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) 


31
32
33
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 31

def id
  @id
end

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

Returns:



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

def idcs_created_by
  @idcs_created_by
end

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

Returns:



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

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) 


123
124
125
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 123

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>) 


81
82
83
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 81

def idcs_prevented_operations
  @idcs_prevented_operations
end

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

Returns:



62
63
64
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 62

def meta
  @meta
end

#name ⇒ String

[Required] Name of the profile

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

Returns:

  • (String) 


191
192
193
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 191

def name
  @name
end

#number_of_days_redirect_url_is_valid ⇒ Integer

[Required] Number of days redirect URL is valid

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

Returns:

  • (Integer) 


217
218
219
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 217

def number_of_days_redirect_url_is_valid
  @number_of_days_redirect_url_is_valid
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) 


45
46
47
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 45

def ocid
  @ocid
end

#redirect_url ⇒ String

[Required] This URL will be replaced in email notification sent to user. When activation email required is set to true, user is created in \“pending verification\” state, upon clicking this link user will be able to activate himself. When activation email required is set to false, user is created in \“verified\” state, this link will be used to verify user's email.

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

Returns:

  • (String) 


311
312
313
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 311

def redirect_url
  @redirect_url
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>) 


59
60
61
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 59

def schemas
  @schemas
end

#show_on_login_page ⇒ BOOLEAN

[Required] A Boolean value that indicates whether the profile should be displayed on login page

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

Returns:

  • (BOOLEAN) 


245
246
247
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 245

def 
  @show_on_login_page
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:



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

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) 


165
166
167
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 165

def tenancy_ocid
  @tenancy_ocid
end

#user_attributes ⇒ Array<OCI::IdentityDomains::Models::SelfRegistrationProfileUserAttributes>

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

Returns:



368
369
370
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 368

def user_attributes
  @user_attributes
end

Class Method Details

.attribute_map ⇒ Object

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



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
463
464
465
466
467
468
469
470
471
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 433

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',
    'external_id': :'externalId',
    'name': :'name',
    'activation_email_required': :'activationEmailRequired',
    'number_of_days_redirect_url_is_valid': :'numberOfDaysRedirectUrlIsValid',
    'active': :'active',
    'show_on_login_page': :'showOnLoginPage',
    'allowed_email_domains': :'allowedEmailDomains',
    'disallowed_email_domains': :'disallowedEmailDomains',
    'header_logo': :'headerLogo',
    'footer_logo': :'footerLogo',
    'redirect_url': :'redirectUrl',
    'consent_text_present': :'consentTextPresent',
    'display_name': :'displayName',
    'after_submit_text': :'afterSubmitText',
    'user_attributes': :'userAttributes',
    'email_template': :'emailTemplate',
    'default_groups': :'defaultGroups',
    'header_text': :'headerText',
    'footer_text': :'footerText',
    'consent_text': :'consentText'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



474
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
508
509
510
511
512
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 474

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',
    'external_id': :'String',
    'name': :'String',
    'activation_email_required': :'BOOLEAN',
    'number_of_days_redirect_url_is_valid': :'Integer',
    'active': :'BOOLEAN',
    'show_on_login_page': :'BOOLEAN',
    'allowed_email_domains': :'Array<String>',
    'disallowed_email_domains': :'Array<String>',
    'header_logo': :'String',
    'footer_logo': :'String',
    'redirect_url': :'String',
    'consent_text_present': :'BOOLEAN',
    'display_name': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileDisplayName>',
    'after_submit_text': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileAfterSubmitText>',
    'user_attributes': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileUserAttributes>',
    'email_template': :'OCI::IdentityDomains::Models::SelfRegistrationProfileEmailTemplate',
    'default_groups': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileDefaultGroups>',
    'header_text': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileHeaderText>',
    'footer_text': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileFooterText>',
    'consent_text': :'Array<OCI::IdentityDomains::Models::SelfRegistrationProfileConsentText>'
    # 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



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

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 &&
    external_id == other.external_id &&
    name == other.name &&
    activation_email_required == other.activation_email_required &&
    number_of_days_redirect_url_is_valid == other.number_of_days_redirect_url_is_valid &&
    active == other.active &&
     == other. &&
    allowed_email_domains == other.allowed_email_domains &&
    disallowed_email_domains == other.disallowed_email_domains &&
     == other. &&
     == other. &&
    redirect_url == other.redirect_url &&
    consent_text_present == other.consent_text_present &&
    display_name == other.display_name &&
    after_submit_text == other.after_submit_text &&
    user_attributes == other.user_attributes &&
    email_template == other.email_template &&
    default_groups == other.default_groups &&
    header_text == other.header_text &&
    footer_text == other.footer_text &&
    consent_text == other.consent_text
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



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 819

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


799
800
801
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 799

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



808
809
810
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 808

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, external_id, name, activation_email_required, number_of_days_redirect_url_is_valid, active, , allowed_email_domains, disallowed_email_domains, , , redirect_url, consent_text_present, display_name, after_submit_text, user_attributes, email_template, default_groups, header_text, footer_text, consent_text].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



852
853
854
855
856
857
858
859
860
861
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 852

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



846
847
848
 
# File 'lib/oci/identity_domains/models/self_registration_profile.rb', line 846

def to_s
  to_hash.to_s
end