Package com.oracle.bmc.identitydomains.model

Class Setting

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class Setting
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Settings schema
    Note: Objects should always be created or deserialized using the Setting.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 Setting.Builder, which maintain a set of all explicitly set fields called Setting.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:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value

      • getContactEmails

        public List<String> getContactEmails()
        Contact emails used to notify tenants.

        Can be one or more user or group alias emails.

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

        Returns:
        the value

      • getCustomBranding

        public Boolean getCustomBranding()
        Indicates if the branding is default or custom

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

        Returns:
        the value

      • getPreferredLanguage

        public String getPreferredLanguage()
        Preferred written or spoken language used for localized user interfaces

        *SCIM++ Properties:** - caseExact: false - idcsCanonicalValueSourceFilter: attrName eq "languages" and attrValues.value eq "$(preferredLanguage)" - idcsCanonicalValueSourceResourceType: AllowedValue - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value

      • getTimezone

        public String getTimezone()
        User’s timezone

        *SCIM++ Properties:** - caseExact: false - idcsCanonicalValueSourceFilter: attrName eq "timezones" and attrValues.value eq "$(timezone)" - idcsCanonicalValueSourceResourceType: AllowedValue - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value

      • getDiagnosticRecordForSearchIdentifiesReturnedResources

        public Boolean getDiagnosticRecordForSearchIdentifiesReturnedResources()
        Controls whether DiagnosticRecords for external search-operations (against SCIM resource-types in the Admin service) identify returned resources.

        If true, indicates that for each successful external search-operation at least one DiagnosticRecord will include at least one identifier for each matching resource that is returned in that search-response. If false, no DiagnosticRecord should be expected to identify returned resources for a search-operation. The default value is false.

        *Added In:** 2011192329

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

        Returns:
        the value

      • getReAuthWhenChangingMyAuthenticationFactors

        public Boolean getReAuthWhenChangingMyAuthenticationFactors()
        Specifies whether re-authentication is required or not when a user changes one of their security factors such as password or email.

        Default is true to ensure more secure behavior.

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getReAuthFactor

        public List<Setting.ReAuthFactor> getReAuthFactor()
        If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use.

        Allowed value is \“password\”.

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getLocale

        public String getLocale()
        Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.

        *SCIM++ Properties:** - caseExact: false - idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(locale)" - idcsCanonicalValueSourceResourceType: AllowedValue - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value

      • getCsrAccess

        public Setting.CsrAccess getCsrAccess()
        This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access.

        A value of ‘none’ means CSR cannot login to the services.

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

        Returns:
        the value

      • getSigningCertPublicAccess

        public Boolean getSigningCertPublicAccess()
        Indicates if access on SigningCert is allowed to public or not

        *Added In:** 17.3.4

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

        Returns:
        the value

      • getSubMappingAttr

        public String getSubMappingAttr()
        Added In: 20.1.3

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none Subject mapping user profile attribute. The input format should be SCIM compliant. This attribute should be of type String and multivalued to false.

        Returns:
        the value

      • getAccountAlwaysTrustScope

        public Boolean getAccountAlwaysTrustScope()
        Indicates whether all the Apps in this customer tenancy should trust each other.

        A value of true overrides the ‘defaultTrustScope’ attribute here in Settings, as well as any App-specific ‘trustScope’ attribute, to force in effect ‘trustScope=Account’ for every App in this customer tenancy.

        *Added In:** 18.1.6

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

        Returns:
        the value

      • getDefaultTrustScope

        public Setting.DefaultTrustScope getDefaultTrustScope()
        Deprecated Since: 18.3.6

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string Indicates the default trust scope for all apps

        Returns:
        the value

      • getIssuer

        public String getIssuer()
        Tenant issuer.

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getPrevIssuer

        public String getPrevIssuer()
        Previous Tenant issuer.

        This is an Oracle Identity Cloud Service internal attribute which is not meant to be directly modified by ID Admin. Even if the request body (Settings) contains this attribute, the actual value will be set according to the Oracle Identity Cloud Service internal logic rather than solely based on the value provided in the request payload.

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getDiagnosticLevel

        public Integer getDiagnosticLevel()
        The level of diagnostic logging that is currently in effect.

        A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled.

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

        Returns:
        the value

      • getDiagnosticTracingUpto

        public String getDiagnosticTracingUpto()
        The end time up to which diagnostic recording is switched on

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

        Returns:
        the value

      • getAllowedDomains

        public List<String> getAllowedDomains()
        One or more email domains allowed in a user’s email field.

        If unassigned, any domain is allowed.

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

        Returns:
        the value

      • getEnableTermsOfUse

        public Boolean getEnableTermsOfUse()
        Indicates if Terms of Use is enabled in UI

        *Added In:** 18.2.4

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

        Returns:
        the value

      • getTermsOfUseUrl

        public String getTermsOfUseUrl()
        Terms of Use URL

        *Added In:** 18.2.4

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

        Returns:
        the value

      • getPrivacyPolicyUrl

        public String getPrivacyPolicyUrl()
        Privacy Policy URL

        *Added In:** 18.2.4

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

        Returns:
        the value

      • getMigrationStatus

        public String getMigrationStatus()
        Database Migration Status

        *Added In:** 19.2.1

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

        Returns:
        the value

      • getOnPremisesProvisioning

        public Boolean getOnPremisesProvisioning()
        On-Premises provisioning feature toggle.

        *Added In:** 19.2.1

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

        Returns:
        the value

      • getAllowedForgotPasswordFlowReturnUrls

        public List<String> getAllowedForgotPasswordFlowReturnUrls()
        If specified, indicates the set of Urls which can be returned to after successful forgot password flow

        *Added In:** 19.3.3

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

        Returns:
        the value

      • getAllowedNotificationRedirectUrls

        public List<String> getAllowedNotificationRedirectUrls()
        If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of \“notificationRedirectUrl\” in the POST …/admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow.

        *Added In:** 2009041201

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

        Returns:
        the value

      • getAuditEventRetentionPeriod

        public Integer getAuditEventRetentionPeriod()
        Audit Event retention period.

        If set, overrides default of 30 days after which Audit Events will be purged

        *Added In:** 19.2.1

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer

        Returns:
        the value

      • getIsHostedPage

        public Boolean getIsHostedPage()
        Indicates if ‘hosted’ option was selected

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getCustomHtmlLocation

        public String getCustomHtmlLocation()
        Storage URL location where the sanitized custom html is located

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getCustomCssLocation

        public String getCustomCssLocation()
        Storage URL location where the sanitized custom css is located

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getCustomTranslation

        public String getCustomTranslation()
        Custom translations (JSON String)

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getCloudAccountName

        public String getCloudAccountName()
        The attribute to store the cloud account name

        *Deprecated Since: 2011192329**

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

        Returns:
        the value

      • getCloudMigrationUrlEnabled

        public Boolean getCloudMigrationUrlEnabled()
        CloudAccountMigration: Enable Custom SIM Migrator Url.

        *Added In:** 2012271618

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

        Returns:
        the value

      • getCloudMigrationCustomUrl

        public String getCloudMigrationCustomUrl()
        If specified, indicates the custom SIM Migrator Url which can be used while SIM to Oracle Identity Cloud Service CloudAccount Migration.

        *Added In:** 2012271618

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

        Returns:
        the value

      • getServiceAdminCannotListOtherUsers

        public Boolean getServiceAdminCannotListOtherUsers()
        By default, a service admin can list all users in stripe.

        If true, a service admin cannot list other users.

        *Added In:** 2108190438

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

        Returns:
        the value

      • getMaxNoOfAppRoleMembersToReturn

        public Integer getMaxNoOfAppRoleMembersToReturn()
        Limit the maximum return of members for an AppRole

        *Added In:** 2111112015

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

        Returns:
        the value

      • getMaxNoOfAppCMVAToReturn

        public Integer getMaxNoOfAppCMVAToReturn()
        Limit the maximum return of CMVA for an App

        *Added In:** 2111112015

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

        Returns:
        the value

      • getIamUpstSessionExpiry

        public Integer getIamUpstSessionExpiry()
        Maximum duration for IAM User Principal Session Token expiry

        *Added In:** 2307071836

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

        Returns:
        the value

      • getTenantCustomClaims

        public List<SettingsTenantCustomClaims> getTenantCustomClaims()
        Custom claims associated with the specific tenant

        *Added In:** 18.4.2

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

        Returns:
        the value

      • getPurgeConfigs

        public List<SettingsPurgeConfigs> getPurgeConfigs()
        Purge Configs for different Resource Types

        *Deprecated Since: 19.1.6**

        *SCIM++ Properties:** - idcsCompositeKey: [resourceName] - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex

        Returns:
        the value

      • getDefaultCompanyNames

        public List<SettingsDefaultCompanyNames> getDefaultCompanyNames()
        Default name of the Company in different locales

        *Added In:** 18.2.2

        *SCIM++ Properties:** - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

        Returns:
        the value

      • getDefaultLoginTexts

        public List<SettingsDefaultLoginTexts> getDefaultLoginTexts()
        Default Login text in different locales

        *Added In:** 18.2.2

        *SCIM++ Properties:** - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

        Returns:
        the value

      • getDefaultImages

        public List<SettingsDefaultImages> getDefaultImages()
        References to various images

        *Added In:** 18.2.2

        *SCIM++ Properties:** - idcsCompositeKey: [type] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

        Returns:
        the value

      • getCompanyNames

        public List<SettingsCompanyNames> getCompanyNames()
        Name of the company in different locales

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

        Returns:
        the value

      • getLoginTexts

        public List<SettingsLoginTexts> getLoginTexts()
        Login text in different locales

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

        Returns:
        the value

      • getImages

        public List<SettingsImages> getImages()
        References to various images

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

        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