Package com.oracle.bmc.identitydomains.model

Class SchemaAttributes

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class SchemaAttributes
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A complex type that specifies the set of Resource attributes
    Note: Objects should always be created or deserialized using the SchemaAttributes.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 SchemaAttributes.Builder, which maintain a set of all explicitly set fields called SchemaAttributes.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).

    • Constructor Detail

      • SchemaAttributes

        @Deprecated
@ConstructorProperties({"name","idcsDisplayNameMessageId","idcsRtsaHideAttribute","localizedDisplayName","type","multiValued","description","required","idcsReturnEmptyWhenNull","canonicalValues","idcsDefaultValue","localizedCanonicalValues","caseExact","mutability","returned","uniqueness","idcsCsvAttributeName","idcsComplexAttributeNameMappings","idcsICFBundleAttributeName","idcsICFRequired","idcsICFAttributeType","idcsCsvAttributeNameMappings","referenceTypes","idcsDeprecatedSinceVersion","idcsAddedSinceVersion","idcsDeprecatedSinceReleaseNumber","idcsAddedSinceReleaseNumber","idcsMinLength","idcsMaxLength","idcsMinValue","idcsMaxValue","idcsMultiLanguage","idcsRefResourceAttributes","idcsIndirectRefResourceAttributes","idcsAutoIncrementSeqName","idcsValuePersisted","idcsSensitive","idcsInternal","idcsTrimStringValue","idcsSearchable","idcsGenerated","idcsAuditable","idcsTargetAttributeName","idcsMapsToSameTargetAttributeNameAs","idcsTargetNormAttributeName","idcsTargetAttributeNameToMigrateFrom","idcsTargetUniqueConstraintName","idcsToTargetMapper","idcsFromTargetMapper","idcsDisplayName","idcsCanonicalValueSourceResourceType","idcsCanonicalValueSourceFilter","idcsCanonicalValueSourceResourceTypeID","idcsCanonicalValueSourceDisplayAttrName","idcsCanonicalValueSourceKeyAttrName","idcsCanonicalValueType","idcsValidateReference","idcsCompositeKey","idcsFetchComplexAttributeValues","idcsScimCompliant","idcsAttributeMappable","idcsValuePersistedInOtherAttribute","idcsPii","idcsExcludeFromUpgradePatch","subAttributes","idcsRefResourceAttribute","idcsAttributeCacheable","idcsuiOrder","idcsuiRegexp","idcsuiVisible","idcsuiWidget","idcsFeatures","idcsOptionalPiiCanonicalValues","idcsSanitize","idcsOverrideCommonAttribute","idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete","idcsAllowUpdatesInReadOnlyMode","idcsPaginateResponse","idcsRequiresWriteForAccessFlows","idcsRequiresImmediateReadAfterWriteForAccessFlows"})
public SchemaAttributes​(String name,
                        String idcsDisplayNameMessageId,
                        Boolean idcsRtsaHideAttribute,
                        SchemaLocalizedDisplayName localizedDisplayName,
                        SchemaAttributes.Type type,
                        Boolean multiValued,
                        String description,
                        Boolean required,
                        Boolean idcsReturnEmptyWhenNull,
                        List<String> canonicalValues,
                        String idcsDefaultValue,
                        List<SchemaLocalizedCanonicalValues> localizedCanonicalValues,
                        Boolean caseExact,
                        SchemaAttributes.Mutability mutability,
                        SchemaAttributes.Returned returned,
                        SchemaAttributes.Uniqueness uniqueness,
                        String idcsCsvAttributeName,
                        List<SchemaIdcsComplexAttributeNameMappings> idcsComplexAttributeNameMappings,
                        String idcsICFBundleAttributeName,
                        Boolean idcsICFRequired,
                        SchemaAttributes.IdcsICFAttributeType idcsICFAttributeType,
                        List<SchemaIdcsCsvAttributeNameMappings> idcsCsvAttributeNameMappings,
                        List<String> referenceTypes,
                        Integer idcsDeprecatedSinceVersion,
                        Integer idcsAddedSinceVersion,
                        String idcsDeprecatedSinceReleaseNumber,
                        String idcsAddedSinceReleaseNumber,
                        Integer idcsMinLength,
                        Integer idcsMaxLength,
                        Integer idcsMinValue,
                        Integer idcsMaxValue,
                        Boolean idcsMultiLanguage,
                        List<String> idcsRefResourceAttributes,
                        List<String> idcsIndirectRefResourceAttributes,
                        String idcsAutoIncrementSeqName,
                        Boolean idcsValuePersisted,
                        SchemaAttributes.IdcsSensitive idcsSensitive,
                        Boolean idcsInternal,
                        Boolean idcsTrimStringValue,
                        Boolean idcsSearchable,
                        Boolean idcsGenerated,
                        Boolean idcsAuditable,
                        String idcsTargetAttributeName,
                        String idcsMapsToSameTargetAttributeNameAs,
                        String idcsTargetNormAttributeName,
                        String idcsTargetAttributeNameToMigrateFrom,
                        String idcsTargetUniqueConstraintName,
                        String idcsToTargetMapper,
                        String idcsFromTargetMapper,
                        String idcsDisplayName,
                        String idcsCanonicalValueSourceResourceType,
                        String idcsCanonicalValueSourceFilter,
                        String idcsCanonicalValueSourceResourceTypeID,
                        String idcsCanonicalValueSourceDisplayAttrName,
                        String idcsCanonicalValueSourceKeyAttrName,
                        SchemaAttributes.IdcsCanonicalValueType idcsCanonicalValueType,
                        Boolean idcsValidateReference,
                        List<String> idcsCompositeKey,
                        Boolean idcsFetchComplexAttributeValues,
                        Boolean idcsScimCompliant,
                        Boolean idcsAttributeMappable,
                        Boolean idcsValuePersistedInOtherAttribute,
                        Boolean idcsPii,
                        Boolean idcsExcludeFromUpgradePatch,
                        List<SchemaSubAttributes> subAttributes,
                        String idcsRefResourceAttribute,
                        Boolean idcsAttributeCacheable,
                        Integer idcsuiOrder,
                        String idcsuiRegexp,
                        Boolean idcsuiVisible,
                        SchemaAttributes.IdcsuiWidget idcsuiWidget,
                        List<SchemaAttributes.IdcsFeatures> idcsFeatures,
                        List<String> idcsOptionalPiiCanonicalValues,
                        Boolean idcsSanitize,
                        Boolean idcsOverrideCommonAttribute,
                        Boolean idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete,
                        Boolean idcsAllowUpdatesInReadOnlyMode,
                        Boolean idcsPaginateResponse,
                        Boolean idcsRequiresWriteForAccessFlows,
                        Boolean idcsRequiresImmediateReadAfterWriteForAccessFlows)
        Deprecated.

    • Method Detail

      • getName

        public String getName()
        Attribute’s name

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

        Returns:
        the value

      • getIdcsDisplayNameMessageId

        public String getIdcsDisplayNameMessageId()
        Localized schema attribute display name for use by UI client for displaying attribute labels

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

        Returns:
        the value

      • getIdcsRtsaHideAttribute

        public Boolean getIdcsRtsaHideAttribute()
        Specifies if the attributes in this schema should be hidden externally

        *Added In:** 19.1.4

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

        Returns:
        the value

      • getType

        public SchemaAttributes.Type getType()
        The attribute’s data type–for example, String

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

        Returns:
        the value

      • getMultiValued

        public Boolean getMultiValued()
        Indicates the attribute’s plurality

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

        Returns:
        the value

      • getDescription

        public String getDescription()
        The attribute’s human-readable description

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

        Returns:
        the value

      • getRequired

        public Boolean getRequired()
        Specifies if the attribute is required

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

        Returns:
        the value

      • getIdcsReturnEmptyWhenNull

        public Boolean getIdcsReturnEmptyWhenNull()
        Specifies if the attribute is required

        *Added In:** 2305190132

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

        Returns:
        the value

      • getCanonicalValues

        public List<String> getCanonicalValues()
        A collection of canonical values.

        Applicable Service Providers MUST specify the canonical types specified in the core schema specification–for example, \“work\”, \“home\”.

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

        Returns:
        the value

      • getIdcsDefaultValue

        public String getIdcsDefaultValue()
        Specifies the default value for an attribute.

        The value must be one from canonicalValues if defined.

        *Added In:** 18.1.6

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

        Returns:
        the value

      • getLocalizedCanonicalValues

        public List<SchemaLocalizedCanonicalValues> getLocalizedCanonicalValues()
        A collection of Localized canonical values.

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

        Returns:
        the value

      • getCaseExact

        public Boolean getCaseExact()
        Specifies if the String attribute is case-sensitive

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

        Returns:
        the value

      • getMutability

        public SchemaAttributes.Mutability getMutability()
        Specifies if the attribute is mutable

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

        Returns:
        the value

      • getReturned

        public SchemaAttributes.Returned getReturned()
        A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request

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

        Returns:
        the value

      • getUniqueness

        public SchemaAttributes.Uniqueness getUniqueness()
        A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values.

        A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \“none\”.

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

        Returns:
        the value

      • getIdcsCsvAttributeName

        public String getIdcsCsvAttributeName()
        The attribute defining the CSV header name for import/export

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

        Returns:
        the value

      • getIdcsComplexAttributeNameMappings

        public List<SchemaIdcsComplexAttributeNameMappings> getIdcsComplexAttributeNameMappings()
        Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g.

        email => emails[work].value)

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

        Returns:
        the value

      • getIdcsICFBundleAttributeName

        public String getIdcsICFBundleAttributeName()
        Maps to ICF target attribute name

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

        Returns:
        the value

      • getIdcsICFRequired

        public Boolean getIdcsICFRequired()
        Metadata to identify the ICF required attribute

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

        Returns:
        the value

      • getIdcsICFAttributeType

        public SchemaAttributes.IdcsICFAttributeType getIdcsICFAttributeType()
        Maps to ICF data type

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

        Returns:
        the value

      • getIdcsCsvAttributeNameMappings

        public List<SchemaIdcsCsvAttributeNameMappings> getIdcsCsvAttributeNameMappings()
        Csv meta data for those resource type attributes which can be imported / exported from / to csv.

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

        Returns:
        the value

      • getReferenceTypes

        public List<String> getReferenceTypes()
        The names of the Resource types that may be referenced–for example, User.

        This is only applicable for attributes that are of the \“reference\” data type.

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

        Returns:
        the value

      • getIdcsDeprecatedSinceVersion

        public Integer getIdcsDeprecatedSinceVersion()
        Indicates that the schema has been deprecated since version

        *Deprecated Since: 19.3.3**

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

        Returns:
        the value

      • getIdcsAddedSinceVersion

        public Integer getIdcsAddedSinceVersion()
        Indicates that the schema has been added since version

        *Deprecated Since: 19.3.3**

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

        Returns:
        the value

      • getIdcsDeprecatedSinceReleaseNumber

        public String getIdcsDeprecatedSinceReleaseNumber()
        Indicates that the schema has been deprecated since this release number

        *Added In:** 17.3.4

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

        Returns:
        the value

      • getIdcsAddedSinceReleaseNumber

        public String getIdcsAddedSinceReleaseNumber()
        Indicates that the schema has been added since this release number

        *Added In:** 17.3.4

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

        Returns:
        the value

      • getIdcsMinLength

        public Integer getIdcsMinLength()
        Specifies the minimum length of the attribute

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

        Returns:
        the value

      • getIdcsMaxLength

        public Integer getIdcsMaxLength()
        Specifies the maximum length of the attribute

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

        Returns:
        the value

      • getIdcsMinValue

        public Integer getIdcsMinValue()
        Specifies the minimum value of the integer attribute

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

        Returns:
        the value

      • getIdcsMaxValue

        public Integer getIdcsMaxValue()
        Specifies the maximum value of the integer attribute

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

        Returns:
        the value

      • getIdcsMultiLanguage

        public Boolean getIdcsMultiLanguage()
        If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.

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

        Returns:
        the value

      • getIdcsRefResourceAttributes

        public List<String> getIdcsRefResourceAttributes()
        Specifies the directly referenced Resources

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

        Returns:
        the value

      • getIdcsIndirectRefResourceAttributes

        public List<String> getIdcsIndirectRefResourceAttributes()
        Specifies the indirectly referenced Resources

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

        Returns:
        the value

      • getIdcsAutoIncrementSeqName

        public String getIdcsAutoIncrementSeqName()
        Sequence tracking ID name for the attribute

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

        Returns:
        the value

      • getIdcsValuePersisted

        public Boolean getIdcsValuePersisted()
        Specifies whether the value of the Resource attribute is persisted

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

        Returns:
        the value

      • getIdcsSensitive

        public SchemaAttributes.IdcsSensitive getIdcsSensitive()
        Flag to specify if the attribute should be encrypted or hashed

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

        Returns:
        the value

      • getIdcsInternal

        public Boolean getIdcsInternal()
        Specifies whether the schema attribute is for internal use only.

        Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.

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

        Returns:
        the value

      • getIdcsTrimStringValue

        public Boolean getIdcsTrimStringValue()
        Trims any leading and trailing blanks from String values.

        Default is True.

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

        Returns:
        the value

      • getIdcsSearchable

        public Boolean getIdcsSearchable()
        Specifies whether this attribute can be included in a search filter

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

        Returns:
        the value

      • getIdcsGenerated

        public Boolean getIdcsGenerated()
        Specifies whether this attribute value was generated

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

        Returns:
        the value

      • getIdcsAuditable

        public Boolean getIdcsAuditable()
        Specifies whether changes to this attribute value are audited

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

        Returns:
        the value

      • getIdcsTargetAttributeName

        public String getIdcsTargetAttributeName()
        Target attribute name that this attribute gets mapped to for persistence

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

        Returns:
        the value

      • getIdcsMapsToSameTargetAttributeNameAs

        public String getIdcsMapsToSameTargetAttributeNameAs()
        Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName

        *Added In:** 2209122038

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

        Returns:
        the value

      • getIdcsTargetNormAttributeName

        public String getIdcsTargetNormAttributeName()
        Target normalized attribute name that this normalized value of attribute gets mapped to for persistence.

        Only set for caseExact=false & searchable attributes. Do not use by default.

        *Added In:** 19.2.1

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

        Returns:
        the value

      • getIdcsTargetAttributeNameToMigrateFrom

        public String getIdcsTargetAttributeNameToMigrateFrom()
        Old Target attribute name from child table for CSVA attribute prior to migration.

        This maintains this attribute used to get mapped to for persistence

        *Added In:** 19.2.1

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

        Returns:
        the value

      • getIdcsTargetUniqueConstraintName

        public String getIdcsTargetUniqueConstraintName()
        Target index name created for this attribute for performance

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

        Returns:
        the value

      • getIdcsToTargetMapper

        public String getIdcsToTargetMapper()
        Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics

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

        Returns:
        the value

      • getIdcsFromTargetMapper

        public String getIdcsFromTargetMapper()
        Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics

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

        Returns:
        the value

      • getIdcsDisplayName

        public String getIdcsDisplayName()
        Specifies the user-friendly displayable attribute name or catalog key used for localization

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceResourceType

        public String getIdcsCanonicalValueSourceResourceType()
        Specifies the Resource type to read from for dynamic canonical values

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceFilter

        public String getIdcsCanonicalValueSourceFilter()
        Filter to use when getting canonical values for this schema attribute

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceResourceTypeID

        public String getIdcsCanonicalValueSourceResourceTypeID()
        Specifies the Resource type ID to read from for dynamic canonical values

        *Added In:** 17.4.6

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceDisplayAttrName

        public String getIdcsCanonicalValueSourceDisplayAttrName()
        Display name for the canonical value attribute name.

        *Added In:** 17.4.6

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceKeyAttrName

        public String getIdcsCanonicalValueSourceKeyAttrName()
        Source key attribute for the canonical value.

        *Added In:** 17.4.6

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

        Returns:
        the value

      • getIdcsCanonicalValueType

        public SchemaAttributes.IdcsCanonicalValueType getIdcsCanonicalValueType()
        Type of the canonical value.

        *Added In:** 17.4.6

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

        Returns:
        the value

      • getIdcsValidateReference

        public Boolean getIdcsValidateReference()
        Validate payload reference value during create, replace, and update.

        Default is True.

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

        Returns:
        the value

      • getIdcsCompositeKey

        public List<String> getIdcsCompositeKey()
        The set of one or more sub attributes’ names of a CMVA, whose values uniquely identify an instance of a CMVA

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

        Returns:
        the value

      • getIdcsFetchComplexAttributeValues

        public Boolean getIdcsFetchComplexAttributeValues()
        SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update.

        Default is true.

        Returns:
        the value

      • getIdcsScimCompliant

        public Boolean getIdcsScimCompliant()
        Indicates if the attribute is scim compliant, default is true

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

        Returns:
        the value

      • getIdcsAttributeMappable

        public Boolean getIdcsAttributeMappable()
        Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP.

        If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored

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

        Returns:
        the value

      • getIdcsValuePersistedInOtherAttribute

        public Boolean getIdcsValuePersistedInOtherAttribute()
        If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation

        *Added In:** 18.2.2

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

        Returns:
        the value

      • getIdcsPii

        public Boolean getIdcsPii()
        Specifies whether the attribute is PII (personal information).

        False by default for all attributes. If attribute with idcsPii = true, it’s value must be obfuscated before it’s written to the Oracle Identity Cloud Service system logs.

        *Added In:** 18.4.2

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

        Returns:
        the value

      • getIdcsExcludeFromUpgradePatch

        public Boolean getIdcsExcludeFromUpgradePatch()
        Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.

        *Added In:** 2104150946

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

        Returns:
        the value

      • getSubAttributes

        public List<SchemaSubAttributes> getSubAttributes()
        A list specifying the contained attributes

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

        Returns:
        the value

      • getIdcsRefResourceAttribute

        public String getIdcsRefResourceAttribute()
        Specifies the referenced Resource attribute

        *Deprecated Since: 17.3.4**

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

        Returns:
        the value

      • getIdcsAttributeCacheable

        public Boolean getIdcsAttributeCacheable()
        Specifies whether the attribute is cacheable.

        True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \“attributesToGet\” while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.

        *Added In:** 17.3.4

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

        Returns:
        the value

      • getIdcsuiOrder

        public Integer getIdcsuiOrder()
        Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.

        *Added In:** 17.4.2

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

        Returns:
        the value

      • getIdcsuiRegexp

        public String getIdcsuiRegexp()
        Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.

        *Added In:** 17.4.2

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

        Returns:
        the value

      • getIdcsuiVisible

        public Boolean getIdcsuiVisible()
        Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.

        *Added In:** 17.4.2

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

        Returns:
        the value

      • getIdcsuiWidget

        public SchemaAttributes.IdcsuiWidget getIdcsuiWidget()
        Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.

        *Added In:** 17.4.2

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

        Returns:
        the value

      • getIdcsFeatures

        public List<SchemaAttributes.IdcsFeatures> getIdcsFeatures()
        The list of features that require this attribute

        *Deprecated Since: 19.1.6**

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

        Returns:
        the value

      • getIdcsOptionalPiiCanonicalValues

        public List<String> getIdcsOptionalPiiCanonicalValues()
        A subset of \“canonicalValues\” that are not supported when the \“optionalPii\” feature is disabled in GlobalConfig.

        *Deprecated Since: 19.1.6**

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

        Returns:
        the value

      • getIdcsSanitize

        public Boolean getIdcsSanitize()
        Specifies if the value of the attribute should be sanitized using OWASP library for HTML content

        *Added In:** 20.1.3

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

        Returns:
        the value

      • getIdcsOverrideCommonAttribute

        public Boolean getIdcsOverrideCommonAttribute()
        Specifies whether the attribute from resource schema should override from common schema with the same name.

        *Added In:** 2102181953

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

        Returns:
        the value

      • getIdcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete

        public Boolean getIdcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete()
        Specifies whether the readOnly and immutable reference attributes should be ignored when forceDelete=true.

        *Added In:** 2104220644

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

        Returns:
        the value

      • getIdcsAllowUpdatesInReadOnlyMode

        public Boolean getIdcsAllowUpdatesInReadOnlyMode()
        Set this attribute to True if the resource is eligibal for update while system is in readonly mode.

        *Added In:** 2106170416

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

        Returns:
        the value

      • getIdcsPaginateResponse

        public Boolean getIdcsPaginateResponse()
        Set this attribute to True if the pagination is required on an attribute.

        *Added In:** 2202230830

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

        Returns:
        the value

      • getIdcsRequiresWriteForAccessFlows

        public Boolean getIdcsRequiresWriteForAccessFlows()
        If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.

        *Added In:** 2209220956

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

        Returns:
        the value

      • getIdcsRequiresImmediateReadAfterWriteForAccessFlows

        public Boolean getIdcsRequiresImmediateReadAfterWriteForAccessFlows()
        If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.

        *Added In:** 2209220956

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

        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