Class SelfRegistrationProfile


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: v1")
    public final class SelfRegistrationProfile
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Self Registration Profile
    Note: Objects should always be created or deserialized using the SelfRegistrationProfile.Builder.

    This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SelfRegistrationProfile.Builder, which maintain a set of all explicitly set fields called SelfRegistrationProfile.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        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:
        the value
      • getOcid

        public String getOcid()
        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:
        the value
      • getSchemas

        public List<String> getSchemas()
        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:
        the value
      • getMeta

        public Meta getMeta()
      • getIdcsPreventedOperations

        public List<IdcsPreventedOperations> getIdcsPreventedOperations()
        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:
        the value
      • getTags

        public List<Tags> getTags()
        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:
        the value
      • getDeleteInProgress

        public Boolean getDeleteInProgress()
        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:
        the value
      • getIdcsLastUpgradedInRelease

        public String getIdcsLastUpgradedInRelease()
        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:
        the value
      • getDomainOcid

        public String getDomainOcid()
        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:
        the value
      • getCompartmentOcid

        public String getCompartmentOcid()
        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:
        the value
      • getTenancyOcid

        public String getTenancyOcid()
        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:
        the value
      • getExternalId

        public String getExternalId()
        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:
        the value
      • getName

        public String getName()
        Name of the profile

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

        Returns:
        the value
      • getActivationEmailRequired

        public Boolean getActivationEmailRequired()
        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:
        the value
      • getNumberOfDaysRedirectUrlIsValid

        public Integer getNumberOfDaysRedirectUrlIsValid()
        Number of days redirect URL is valid

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

        Returns:
        the value
      • getActive

        public Boolean getActive()
        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:
        the value
      • getShowOnLoginPage

        public Boolean getShowOnLoginPage()
        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:
        the value
      • getAllowedEmailDomains

        public List<String> getAllowedEmailDomains()
        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:
        the value
      • getDisallowedEmailDomains

        public List<String> getDisallowedEmailDomains()
        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:
        the value
      • getHeaderLogo

        public String getHeaderLogo()
        Reference to header logo

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

        Returns:
        the value
      • getFooterLogo

        public String getFooterLogo()
        References to footer logo

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

        Returns:
        the value
      • getRedirectUrl

        public String getRedirectUrl()
        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:
        the value
      • getConsentTextPresent

        public Boolean getConsentTextPresent()
        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:
        the value
      • getDisplayName

        public List<SelfRegistrationProfileDisplayName> getDisplayName()
        Registration page name

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

        Returns:
        the value
      • getAfterSubmitText

        public List<SelfRegistrationProfileAfterSubmitText> getAfterSubmitText()
        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:
        the value
      • getUserAttributes

        public List<SelfRegistrationProfileUserAttributes> getUserAttributes()

        SCIM++ Properties: - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true

        • mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none User Attributes
        Returns:
        the value
      • getDefaultGroups

        public List<SelfRegistrationProfileDefaultGroups> getDefaultGroups()
        Default groups assigned to the user

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

        Returns:
        the value
      • getHeaderText

        public List<SelfRegistrationProfileHeaderText> getHeaderText()
        Header text

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

        Returns:
        the value
      • getFooterText

        public List<SelfRegistrationProfileFooterText> getFooterText()
        Footer text

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

        Returns:
        the value
      • getConsentText

        public List<SelfRegistrationProfileConsentText> getConsentText()
        Consent text

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

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel