Package com.oracle.bmc.identitydomains.model

Class SchemaAttributes.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • name

        public SchemaAttributes.Builder name​(String name)
        Attribute’s name

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

        Parameters:
        name - the value to set
        Returns:
        this builder

      • idcsDisplayNameMessageId

        public SchemaAttributes.Builder idcsDisplayNameMessageId​(String idcsDisplayNameMessageId)
        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

        Parameters:
        idcsDisplayNameMessageId - the value to set
        Returns:
        this builder

      • idcsRtsaHideAttribute

        public SchemaAttributes.Builder idcsRtsaHideAttribute​(Boolean idcsRtsaHideAttribute)
        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

        Parameters:
        idcsRtsaHideAttribute - the value to set
        Returns:
        this builder

      • type

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

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

        Parameters:
        type - the value to set
        Returns:
        this builder

      • multiValued

        public SchemaAttributes.Builder multiValued​(Boolean multiValued)
        Indicates the attribute’s plurality

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

        Parameters:
        multiValued - the value to set
        Returns:
        this builder

      • description

        public SchemaAttributes.Builder description​(String description)
        The attribute’s human-readable description

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

        Parameters:
        description - the value to set
        Returns:
        this builder

      • required

        public SchemaAttributes.Builder required​(Boolean required)
        Specifies if the attribute is required

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

        Parameters:
        required - the value to set
        Returns:
        this builder

      • idcsReturnEmptyWhenNull

        public SchemaAttributes.Builder idcsReturnEmptyWhenNull​(Boolean idcsReturnEmptyWhenNull)
        Specifies if the attribute is required

        *Added In:** 2305190132

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

        Parameters:
        idcsReturnEmptyWhenNull - the value to set
        Returns:
        this builder

      • canonicalValues

        public SchemaAttributes.Builder canonicalValues​(List<String> canonicalValues)
        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

        Parameters:
        canonicalValues - the value to set
        Returns:
        this builder

      • idcsDefaultValue

        public SchemaAttributes.Builder idcsDefaultValue​(String idcsDefaultValue)
        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

        Parameters:
        idcsDefaultValue - the value to set
        Returns:
        this builder

      • localizedCanonicalValues

        public SchemaAttributes.Builder localizedCanonicalValues​(List<SchemaLocalizedCanonicalValues> localizedCanonicalValues)
        A collection of Localized canonical values.

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

        Parameters:
        localizedCanonicalValues - the value to set
        Returns:
        this builder

      • caseExact

        public SchemaAttributes.Builder caseExact​(Boolean caseExact)
        Specifies if the String attribute is case-sensitive

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

        Parameters:
        caseExact - the value to set
        Returns:
        this builder

      • mutability

        public SchemaAttributes.Builder mutability​(SchemaAttributes.Mutability mutability)
        Specifies if the attribute is mutable

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

        Parameters:
        mutability - the value to set
        Returns:
        this builder

      • returned

        public SchemaAttributes.Builder returned​(SchemaAttributes.Returned returned)
        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

        Parameters:
        returned - the value to set
        Returns:
        this builder

      • uniqueness

        public SchemaAttributes.Builder uniqueness​(SchemaAttributes.Uniqueness uniqueness)
        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

        Parameters:
        uniqueness - the value to set
        Returns:
        this builder

      • idcsCsvAttributeName

        public SchemaAttributes.Builder idcsCsvAttributeName​(String idcsCsvAttributeName)
        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

        Parameters:
        idcsCsvAttributeName - the value to set
        Returns:
        this builder

      • idcsComplexAttributeNameMappings

        public SchemaAttributes.Builder idcsComplexAttributeNameMappings​(List<SchemaIdcsComplexAttributeNameMappings> idcsComplexAttributeNameMappings)
        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

        Parameters:
        idcsComplexAttributeNameMappings - the value to set
        Returns:
        this builder

      • idcsICFBundleAttributeName

        public SchemaAttributes.Builder idcsICFBundleAttributeName​(String idcsICFBundleAttributeName)
        Maps to ICF target attribute name

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

        Parameters:
        idcsICFBundleAttributeName - the value to set
        Returns:
        this builder

      • idcsICFRequired

        public SchemaAttributes.Builder idcsICFRequired​(Boolean idcsICFRequired)
        Metadata to identify the ICF required attribute

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

        Parameters:
        idcsICFRequired - the value to set
        Returns:
        this builder

      • idcsICFAttributeType

        public SchemaAttributes.Builder idcsICFAttributeType​(SchemaAttributes.IdcsICFAttributeType idcsICFAttributeType)
        Maps to ICF data type

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

        Parameters:
        idcsICFAttributeType - the value to set
        Returns:
        this builder

      • idcsCsvAttributeNameMappings

        public SchemaAttributes.Builder idcsCsvAttributeNameMappings​(List<SchemaIdcsCsvAttributeNameMappings> idcsCsvAttributeNameMappings)
        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

        Parameters:
        idcsCsvAttributeNameMappings - the value to set
        Returns:
        this builder

      • referenceTypes

        public SchemaAttributes.Builder referenceTypes​(List<String> referenceTypes)
        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

        Parameters:
        referenceTypes - the value to set
        Returns:
        this builder

      • idcsDeprecatedSinceVersion

        public SchemaAttributes.Builder idcsDeprecatedSinceVersion​(Integer idcsDeprecatedSinceVersion)
        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

        Parameters:
        idcsDeprecatedSinceVersion - the value to set
        Returns:
        this builder

      • idcsAddedSinceVersion

        public SchemaAttributes.Builder idcsAddedSinceVersion​(Integer idcsAddedSinceVersion)
        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

        Parameters:
        idcsAddedSinceVersion - the value to set
        Returns:
        this builder

      • idcsDeprecatedSinceReleaseNumber

        public SchemaAttributes.Builder idcsDeprecatedSinceReleaseNumber​(String idcsDeprecatedSinceReleaseNumber)
        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

        Parameters:
        idcsDeprecatedSinceReleaseNumber - the value to set
        Returns:
        this builder

      • idcsAddedSinceReleaseNumber

        public SchemaAttributes.Builder idcsAddedSinceReleaseNumber​(String idcsAddedSinceReleaseNumber)
        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

        Parameters:
        idcsAddedSinceReleaseNumber - the value to set
        Returns:
        this builder

      • idcsMinLength

        public SchemaAttributes.Builder idcsMinLength​(Integer idcsMinLength)
        Specifies the minimum length of the attribute

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

        Parameters:
        idcsMinLength - the value to set
        Returns:
        this builder

      • idcsMaxLength

        public SchemaAttributes.Builder idcsMaxLength​(Integer idcsMaxLength)
        Specifies the maximum length of the attribute

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

        Parameters:
        idcsMaxLength - the value to set
        Returns:
        this builder

      • idcsMinValue

        public SchemaAttributes.Builder idcsMinValue​(Integer idcsMinValue)
        Specifies the minimum value of the integer attribute

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

        Parameters:
        idcsMinValue - the value to set
        Returns:
        this builder

      • idcsMaxValue

        public SchemaAttributes.Builder idcsMaxValue​(Integer idcsMaxValue)
        Specifies the maximum value of the integer attribute

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

        Parameters:
        idcsMaxValue - the value to set
        Returns:
        this builder

      • idcsMultiLanguage

        public SchemaAttributes.Builder idcsMultiLanguage​(Boolean idcsMultiLanguage)
        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

        Parameters:
        idcsMultiLanguage - the value to set
        Returns:
        this builder

      • idcsRefResourceAttributes

        public SchemaAttributes.Builder idcsRefResourceAttributes​(List<String> idcsRefResourceAttributes)
        Specifies the directly referenced Resources

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

        Parameters:
        idcsRefResourceAttributes - the value to set
        Returns:
        this builder

      • idcsIndirectRefResourceAttributes

        public SchemaAttributes.Builder idcsIndirectRefResourceAttributes​(List<String> idcsIndirectRefResourceAttributes)
        Specifies the indirectly referenced Resources

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

        Parameters:
        idcsIndirectRefResourceAttributes - the value to set
        Returns:
        this builder

      • idcsAutoIncrementSeqName

        public SchemaAttributes.Builder idcsAutoIncrementSeqName​(String idcsAutoIncrementSeqName)
        Sequence tracking ID name for the attribute

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

        Parameters:
        idcsAutoIncrementSeqName - the value to set
        Returns:
        this builder

      • idcsValuePersisted

        public SchemaAttributes.Builder idcsValuePersisted​(Boolean idcsValuePersisted)
        Specifies whether the value of the Resource attribute is persisted

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

        Parameters:
        idcsValuePersisted - the value to set
        Returns:
        this builder

      • idcsSensitive

        public SchemaAttributes.Builder idcsSensitive​(SchemaAttributes.IdcsSensitive idcsSensitive)
        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

        Parameters:
        idcsSensitive - the value to set
        Returns:
        this builder

      • idcsInternal

        public SchemaAttributes.Builder idcsInternal​(Boolean idcsInternal)
        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

        Parameters:
        idcsInternal - the value to set
        Returns:
        this builder

      • idcsTrimStringValue

        public SchemaAttributes.Builder idcsTrimStringValue​(Boolean idcsTrimStringValue)
        Trims any leading and trailing blanks from String values.

        Default is True.

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

        Parameters:
        idcsTrimStringValue - the value to set
        Returns:
        this builder

      • idcsSearchable

        public SchemaAttributes.Builder idcsSearchable​(Boolean idcsSearchable)
        Specifies whether this attribute can be included in a search filter

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

        Parameters:
        idcsSearchable - the value to set
        Returns:
        this builder

      • idcsGenerated

        public SchemaAttributes.Builder idcsGenerated​(Boolean idcsGenerated)
        Specifies whether this attribute value was generated

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

        Parameters:
        idcsGenerated - the value to set
        Returns:
        this builder

      • idcsAuditable

        public SchemaAttributes.Builder idcsAuditable​(Boolean idcsAuditable)
        Specifies whether changes to this attribute value are audited

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

        Parameters:
        idcsAuditable - the value to set
        Returns:
        this builder

      • idcsTargetAttributeName

        public SchemaAttributes.Builder idcsTargetAttributeName​(String idcsTargetAttributeName)
        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

        Parameters:
        idcsTargetAttributeName - the value to set
        Returns:
        this builder

      • idcsMapsToSameTargetAttributeNameAs

        public SchemaAttributes.Builder idcsMapsToSameTargetAttributeNameAs​(String idcsMapsToSameTargetAttributeNameAs)
        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

        Parameters:
        idcsMapsToSameTargetAttributeNameAs - the value to set
        Returns:
        this builder

      • idcsTargetNormAttributeName

        public SchemaAttributes.Builder idcsTargetNormAttributeName​(String idcsTargetNormAttributeName)
        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

        Parameters:
        idcsTargetNormAttributeName - the value to set
        Returns:
        this builder

      • idcsTargetAttributeNameToMigrateFrom

        public SchemaAttributes.Builder idcsTargetAttributeNameToMigrateFrom​(String idcsTargetAttributeNameToMigrateFrom)
        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

        Parameters:
        idcsTargetAttributeNameToMigrateFrom - the value to set
        Returns:
        this builder

      • idcsTargetUniqueConstraintName

        public SchemaAttributes.Builder idcsTargetUniqueConstraintName​(String idcsTargetUniqueConstraintName)
        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

        Parameters:
        idcsTargetUniqueConstraintName - the value to set
        Returns:
        this builder

      • idcsToTargetMapper

        public SchemaAttributes.Builder idcsToTargetMapper​(String idcsToTargetMapper)
        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

        Parameters:
        idcsToTargetMapper - the value to set
        Returns:
        this builder

      • idcsFromTargetMapper

        public SchemaAttributes.Builder idcsFromTargetMapper​(String idcsFromTargetMapper)
        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

        Parameters:
        idcsFromTargetMapper - the value to set
        Returns:
        this builder

      • idcsDisplayName

        public SchemaAttributes.Builder idcsDisplayName​(String idcsDisplayName)
        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

        Parameters:
        idcsDisplayName - the value to set
        Returns:
        this builder

      • idcsCanonicalValueSourceResourceType

        public SchemaAttributes.Builder idcsCanonicalValueSourceResourceType​(String idcsCanonicalValueSourceResourceType)
        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

        Parameters:
        idcsCanonicalValueSourceResourceType - the value to set
        Returns:
        this builder

      • idcsCanonicalValueSourceFilter

        public SchemaAttributes.Builder idcsCanonicalValueSourceFilter​(String idcsCanonicalValueSourceFilter)
        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

        Parameters:
        idcsCanonicalValueSourceFilter - the value to set
        Returns:
        this builder

      • idcsCanonicalValueSourceResourceTypeID

        public SchemaAttributes.Builder idcsCanonicalValueSourceResourceTypeID​(String idcsCanonicalValueSourceResourceTypeID)
        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

        Parameters:
        idcsCanonicalValueSourceResourceTypeID - the value to set
        Returns:
        this builder

      • idcsCanonicalValueSourceDisplayAttrName

        public SchemaAttributes.Builder idcsCanonicalValueSourceDisplayAttrName​(String idcsCanonicalValueSourceDisplayAttrName)
        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

        Parameters:
        idcsCanonicalValueSourceDisplayAttrName - the value to set
        Returns:
        this builder

      • idcsCanonicalValueSourceKeyAttrName

        public SchemaAttributes.Builder idcsCanonicalValueSourceKeyAttrName​(String idcsCanonicalValueSourceKeyAttrName)
        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

        Parameters:
        idcsCanonicalValueSourceKeyAttrName - the value to set
        Returns:
        this builder

      • idcsCanonicalValueType

        public SchemaAttributes.Builder idcsCanonicalValueType​(SchemaAttributes.IdcsCanonicalValueType idcsCanonicalValueType)
        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

        Parameters:
        idcsCanonicalValueType - the value to set
        Returns:
        this builder

      • idcsValidateReference

        public SchemaAttributes.Builder idcsValidateReference​(Boolean idcsValidateReference)
        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

        Parameters:
        idcsValidateReference - the value to set
        Returns:
        this builder

      • idcsCompositeKey

        public SchemaAttributes.Builder idcsCompositeKey​(List<String> idcsCompositeKey)
        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

        Parameters:
        idcsCompositeKey - the value to set
        Returns:
        this builder

      • idcsFetchComplexAttributeValues

        public SchemaAttributes.Builder idcsFetchComplexAttributeValues​(Boolean idcsFetchComplexAttributeValues)
        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.

        Parameters:
        idcsFetchComplexAttributeValues - the value to set
        Returns:
        this builder

      • idcsScimCompliant

        public SchemaAttributes.Builder idcsScimCompliant​(Boolean idcsScimCompliant)
        Indicates if the attribute is scim compliant, default is true

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

        Parameters:
        idcsScimCompliant - the value to set
        Returns:
        this builder

      • idcsAttributeMappable

        public SchemaAttributes.Builder idcsAttributeMappable​(Boolean idcsAttributeMappable)
        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

        Parameters:
        idcsAttributeMappable - the value to set
        Returns:
        this builder

      • idcsValuePersistedInOtherAttribute

        public SchemaAttributes.Builder idcsValuePersistedInOtherAttribute​(Boolean idcsValuePersistedInOtherAttribute)
        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

        Parameters:
        idcsValuePersistedInOtherAttribute - the value to set
        Returns:
        this builder

      • idcsPii

        public SchemaAttributes.Builder idcsPii​(Boolean idcsPii)
        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

        Parameters:
        idcsPii - the value to set
        Returns:
        this builder

      • idcsExcludeFromUpgradePatch

        public SchemaAttributes.Builder idcsExcludeFromUpgradePatch​(Boolean idcsExcludeFromUpgradePatch)
        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

        Parameters:
        idcsExcludeFromUpgradePatch - the value to set
        Returns:
        this builder

      • subAttributes

        public SchemaAttributes.Builder subAttributes​(List<SchemaSubAttributes> subAttributes)
        A list specifying the contained attributes

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

        Parameters:
        subAttributes - the value to set
        Returns:
        this builder

      • idcsRefResourceAttribute

        public SchemaAttributes.Builder idcsRefResourceAttribute​(String idcsRefResourceAttribute)
        Specifies the referenced Resource attribute

        *Deprecated Since: 17.3.4**

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

        Parameters:
        idcsRefResourceAttribute - the value to set
        Returns:
        this builder

      • idcsAttributeCacheable

        public SchemaAttributes.Builder idcsAttributeCacheable​(Boolean idcsAttributeCacheable)
        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

        Parameters:
        idcsAttributeCacheable - the value to set
        Returns:
        this builder

      • idcsuiOrder

        public SchemaAttributes.Builder idcsuiOrder​(Integer idcsuiOrder)
        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

        Parameters:
        idcsuiOrder - the value to set
        Returns:
        this builder

      • idcsuiRegexp

        public SchemaAttributes.Builder idcsuiRegexp​(String idcsuiRegexp)
        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

        Parameters:
        idcsuiRegexp - the value to set
        Returns:
        this builder

      • idcsuiVisible

        public SchemaAttributes.Builder idcsuiVisible​(Boolean idcsuiVisible)
        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

        Parameters:
        idcsuiVisible - the value to set
        Returns:
        this builder

      • idcsuiWidget

        public SchemaAttributes.Builder idcsuiWidget​(SchemaAttributes.IdcsuiWidget idcsuiWidget)
        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

        Parameters:
        idcsuiWidget - the value to set
        Returns:
        this builder

      • idcsFeatures

        public SchemaAttributes.Builder idcsFeatures​(List<SchemaAttributes.IdcsFeatures> idcsFeatures)
        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

        Parameters:
        idcsFeatures - the value to set
        Returns:
        this builder

      • idcsOptionalPiiCanonicalValues

        public SchemaAttributes.Builder idcsOptionalPiiCanonicalValues​(List<String> idcsOptionalPiiCanonicalValues)
        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

        Parameters:
        idcsOptionalPiiCanonicalValues - the value to set
        Returns:
        this builder

      • idcsSanitize

        public SchemaAttributes.Builder idcsSanitize​(Boolean idcsSanitize)
        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

        Parameters:
        idcsSanitize - the value to set
        Returns:
        this builder

      • idcsOverrideCommonAttribute

        public SchemaAttributes.Builder idcsOverrideCommonAttribute​(Boolean idcsOverrideCommonAttribute)
        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

        Parameters:
        idcsOverrideCommonAttribute - the value to set
        Returns:
        this builder

      • idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete

        public SchemaAttributes.Builder idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete​(Boolean idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete)
        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

        Parameters:
        idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete - the value to set
        Returns:
        this builder

      • idcsAllowUpdatesInReadOnlyMode

        public SchemaAttributes.Builder idcsAllowUpdatesInReadOnlyMode​(Boolean idcsAllowUpdatesInReadOnlyMode)
        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

        Parameters:
        idcsAllowUpdatesInReadOnlyMode - the value to set
        Returns:
        this builder

      • idcsPaginateResponse

        public SchemaAttributes.Builder idcsPaginateResponse​(Boolean idcsPaginateResponse)
        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

        Parameters:
        idcsPaginateResponse - the value to set
        Returns:
        this builder

      • idcsRequiresWriteForAccessFlows

        public SchemaAttributes.Builder idcsRequiresWriteForAccessFlows​(Boolean idcsRequiresWriteForAccessFlows)
        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

        Parameters:
        idcsRequiresWriteForAccessFlows - the value to set
        Returns:
        this builder

      • idcsRequiresImmediateReadAfterWriteForAccessFlows

        public SchemaAttributes.Builder idcsRequiresImmediateReadAfterWriteForAccessFlows​(Boolean idcsRequiresImmediateReadAfterWriteForAccessFlows)
        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

        Parameters:
        idcsRequiresImmediateReadAfterWriteForAccessFlows - the value to set
        Returns:
        this builder