Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SchemaSubAttributes

A list specifying the contained attributes

Enumerations

Properties

Functions

Properties

Optional canonicalValues

canonicalValues: Array<string>

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

Optional caseExact

caseExact: undefined | false | true

Specifies if the String attribute is case-sensitive

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

Optional description

description: undefined | string

Attribute's human-readable description

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

Optional idcsAddedSinceReleaseNumber

idcsAddedSinceReleaseNumber: undefined | string

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

Optional idcsAddedSinceVersion

idcsAddedSinceVersion: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsAttributeCacheable

idcsAttributeCacheable: undefined | false | true

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

Optional idcsAttributeMappable

idcsAttributeMappable: undefined | false | true

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

Optional idcsAuditable

idcsAuditable: undefined | false | true

Specifies whether changes to this attribute value will be audited

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

Optional idcsCanonicalValueSourceDisplayAttrName

idcsCanonicalValueSourceDisplayAttrName: undefined | string

Display name for the canonical value attribute name.

*Added In:** 17.4.4

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

Optional idcsCanonicalValueSourceFilter

idcsCanonicalValueSourceFilter: undefined | string

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

Optional idcsCanonicalValueSourceKeyAttrName

idcsCanonicalValueSourceKeyAttrName: undefined | string

Source key attribute for the canonical value.

*Added In:** 17.4.4

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

Optional idcsCanonicalValueSourceResourceType

idcsCanonicalValueSourceResourceType: undefined | string

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

Optional idcsCanonicalValueSourceResourceTypeID

idcsCanonicalValueSourceResourceTypeID: undefined | string

Specifies the Resource type ID to read from for dynamic canonical values

*Added In:** 17.4.4

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

Optional idcsCsvAttributeName

idcsCsvAttributeName: undefined | string

The attribute that defines the CSV header name for import/export

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

Optional idcsDefaultValue

idcsDefaultValue: undefined | string

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

Optional idcsDeprecatedSinceReleaseNumber

idcsDeprecatedSinceReleaseNumber: undefined | string

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

Optional idcsDeprecatedSinceVersion

idcsDeprecatedSinceVersion: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsDisplayName

idcsDisplayName: undefined | string

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

Optional idcsDisplayNameMessageId

idcsDisplayNameMessageId: undefined | string

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

Optional idcsExcludeFromUpgradePatch

idcsExcludeFromUpgradePatch: undefined | false | true

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

Optional idcsFromTargetMapper

idcsFromTargetMapper: undefined | string

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

Optional idcsGenerated

idcsGenerated: undefined | false | true

Specifies whether this attribute value was generated

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

Optional idcsIndirectRefResourceAttributes

idcsIndirectRefResourceAttributes: Array<string>

Specifies the indirectly referenced Resources

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

Optional idcsInternal

idcsInternal: undefined | false | true

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 internal flag 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

Optional idcsMaxLength

idcsMaxLength: undefined | number

Specifies the maximum length of this attribute

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsMaxValue

idcsMaxValue: undefined | number

Specifies the maximum value of the integer attribute

*SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsMaxValuesReturned

idcsMaxValuesReturned: undefined | number

SCIM++ Properties:

  • caseExact: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: integer
  • uniqueness: none Specify a limit on the number of attribute-values that any caller will receive when requesting a CMVA attribute. If the no of CMVA instances exceeds the limit then Oracle Identity Cloud Service will throw exception. Users can choose to refine the filter on CMVA attribute. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsMinLength

idcsMinLength: undefined | number

Specifies the minimum length of this attribute

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsMinValue

idcsMinValue: undefined | number

Specifies the minimum value of the integer attribute

*SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsOneValueMustBeTrue

idcsOneValueMustBeTrue: undefined | false | true

If true, ARM will ensure atleast one of the instances of CMVA has the attribute value set to true.

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

Optional idcsOnlyOneValueCanBeTrue

idcsOnlyOneValueCanBeTrue: undefined | false | true

If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.

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

Optional idcsPii

idcsPii: undefined | false | true

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.3.6

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

Optional idcsRefResourceAttributes

idcsRefResourceAttributes: Array<string>

Specifies the directly referenced Resources

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

Optional idcsRequiresImmediateReadAfterWriteForAccessFlows

idcsRequiresImmediateReadAfterWriteForAccessFlows: undefined | false | true

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

Optional idcsRequiresWriteForAccessFlows

idcsRequiresWriteForAccessFlows: undefined | false | true

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

*Added In:** 2205120021

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

Optional idcsReturnEmptyWhenNull

idcsReturnEmptyWhenNull: undefined | false | true

Specifies if the attribute is required

*Added In:** 2305190132

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

Optional idcsRtsaHideAttribute

idcsRtsaHideAttribute: undefined | false | true

Specifies if the attributes in this schema can be displayed externally

*Added In:** 19.1.4

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

Optional idcsSanitize

idcsSanitize: undefined | false | true

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

Optional idcsScimCompliant

idcsScimCompliant: undefined | false | true

Indicates if the attribute is scim compliant, default is true

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

Optional idcsSearchable

idcsSearchable: undefined | false | true

Specifies whether this attribute can be included in a search filter

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

Optional idcsSensitive

idcsSensitive: IdcsSensitive

Specifiees if the attribute should be encrypted or hashed

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

Optional idcsTargetAttributeName

idcsTargetAttributeName: undefined | string

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

Optional idcsTargetAttributeNameToMigrateFrom

idcsTargetAttributeNameToMigrateFrom: undefined | string

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

Optional idcsTargetNormAttributeName

idcsTargetNormAttributeName: undefined | string

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.1.4

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

Optional idcsTargetUniqueConstraintName

idcsTargetUniqueConstraintName: undefined | string

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

Optional idcsToTargetMapper

idcsToTargetMapper: undefined | string

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

Optional idcsTrimStringValue

idcsTrimStringValue: undefined | false | true

Trims any leading and trailing blanks from String values. Default is True.

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

Optional idcsValidateReference

idcsValidateReference: undefined | false | true

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

Optional idcsValuePersisted

idcsValuePersisted: undefined | false | true

Specifies whether the sub-attribute of the Resource attribute is persisted

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

Optional idcsValuePersistedInOtherAttribute

idcsValuePersistedInOtherAttribute: undefined | false | true

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

Optional idcsuiOrder

idcsuiOrder: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsuiRegexp

idcsuiRegexp: undefined | string

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

Optional idcsuiVisible

idcsuiVisible: undefined | false | true

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

Optional idcsuiWidget

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

Optional multiValued

multiValued: undefined | false | true

Indicates the attribute's plurality

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

Optional mutability

mutability: Mutability

Specifies if the attribute is mutable

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

Optional name

name: undefined | string

Attribute's name

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

Optional referenceTypes

referenceTypes: Array<string>

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

Optional required

required: undefined | false | true

Specifies if the attribute is required

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

Optional returned

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

Optional type

type: Type

Attribute's data type--for example, String

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

Optional uniqueness

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 a uniqueness of \"none\".

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

Functions

getDeserializedJsonObj

getJsonObj