Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ResourceTypeSchemaAttribute

ResourceTypeSchemaAttribute Schema Definition

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 - idcsSearchable: true - 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 - idcsSearchable: true - returned: default - type: boolean

Optional compartmentOcid

compartmentOcid: undefined | string

OCI Compartment Id (ocid) in which the resource lives.

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

Optional deleteInProgress

deleteInProgress: undefined | false | true

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

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

Optional description

description: undefined | string

The attribute's human-readable description

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

Optional domainOcid

domainOcid: undefined | string

OCI Domain Id (ocid) in which the resource lives.

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

Optional endUserMutability

endUserMutability: EndUserMutability

Specifies User mutability for this attribute

*Added In:** 18.2.6

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

Optional endUserMutabilityAllowedValues

endUserMutabilityAllowedValues: Array<EndUserMutabilityAllowedValues>

Specifies the list of User mutabilities allowed

*Added In:** 18.2.6

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

Optional id

id: undefined | string

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

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

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 - idcsSearchable: true - required: false - returned: default - type: string

Optional idcsAddedSinceVersion

idcsAddedSinceVersion: undefined | number

Indicates that the schema has been added since version

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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 - idcsSearchable: true - 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 - idcsSearchable: true - returned: default - type: boolean

Optional idcsAuditable

idcsAuditable: undefined | false | true

Specifies whether changes to this attribute value are audited

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

Optional idcsAutoIncrementSeqName

idcsAutoIncrementSeqName: undefined | string

Sequence tracking ID name for the attribute

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

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 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 - idcsSearchable: true - returned: default - type: string - uniqueness: none

Optional idcsCompositeKey

idcsCompositeKey: Array<string>

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 - idcsSearchable: true - returned: default - type: string - uniqueness: none

Optional idcsCreatedBy

idcsCreatedBy: model.IdcsCreatedBy

Optional idcsCsvColumnHeaderName

idcsCsvColumnHeaderName: undefined | string

The attribute defining the CSV column header name for import/export

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

Optional idcsCustomAttribute

idcsCustomAttribute: undefined | false | true

custom attribute flag.

*SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - idcsSearchable: true - 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 - idcsSearchable: true - required: false - returned: default - type: string

Optional idcsDeprecatedSinceVersion

idcsDeprecatedSinceVersion: undefined | number

Indicates that the schema has been deprecated since version

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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 - idcsSearchable: true - 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 - idcsSearchable: true - type: string - uniqueness: none

Optional idcsFetchComplexAttributeValues

idcsFetchComplexAttributeValues: undefined | false | true

SCIM++ Properties:

  • caseExact: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • idcsSearchable: true
  • 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.

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 - idcsSearchable: true - returned: default - type: string - uniqueness: none

Optional idcsFullyQualifiedName

idcsFullyQualifiedName: undefined | string

Fully qualified name of this attribute

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

Optional idcsGenerated

idcsGenerated: undefined | false | true

Specifies whether this attribute value was generated

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

Optional idcsICFAttributeType

idcsICFAttributeType: IdcsICFAttributeType

Maps to ICF data type

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

Optional idcsICFBundleAttributeName

idcsICFBundleAttributeName: undefined | string

Maps to ICF target attribute name

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

Optional idcsICFRequired

idcsICFRequired: undefined | false | true

Metadata to identify the ICF required attribute

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

Optional idcsIndirectRefResourceAttributes

idcsIndirectRefResourceAttributes: Array<string>

Specifies the indirectly referenced Resources

*SCIM++ Properties:** - multiValued: true - mutability: readWrite - required: false - idcsSearchable: true - 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 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 - idcsSearchable: true - returned: default - type: boolean

Optional idcsLastModifiedBy

idcsLastModifiedBy: model.IdcsLastModifiedBy

Optional idcsLastUpgradedInRelease

idcsLastUpgradedInRelease: undefined | string

The release number when the resource was upgraded.

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

Optional idcsMaxLength

idcsMaxLength: undefined | number

Specifies the maximum length of the attribute

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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 - idcsSearchable: true - required: false - returned: default - type: integer Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsMinLength

idcsMinLength: undefined | number

Specifies the minimum length of the attribute

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - idcsSearchable: true - 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 - idcsSearchable: true - returned: default - type: integer Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional idcsMultiLanguage

idcsMultiLanguage: undefined | false | true

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 - idcsSearchable: true - required: false - returned: default - type: boolean - uniqueness: none

Optional idcsPreventedOperations

idcsPreventedOperations: Array<IdcsPreventedOperations>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

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

Optional idcsRefResourceAttribute

idcsRefResourceAttribute: undefined | string

Specifies the referenced Resource attribute

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

Optional idcsRefResourceAttributes

idcsRefResourceAttributes: Array<string>

Specifies the directly referenced Resources

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

Optional idcsSchemaUrn

idcsSchemaUrn: undefined | string

Schema URN string that this attribute belongs to

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

Optional idcsScimCompliant

idcsScimCompliant: undefined | false | true

Indicates if the attribute is scim compliant, default is true

*SCIM++ Properties:** - multiValued: false - mutability: readOnly - idcsSearchable: true - 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 - idcsSearchable: true - returned: default - type: boolean

Optional idcsSensitive

idcsSensitive: IdcsSensitive

Flag to specify if the attribute should be encrypted or hashed

*SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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 - idcsSearchable: true - 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.1.4

*SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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: readOnly - required: false - idcsSearchable: true - 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 - idcsSearchable: true - 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 - idcsSearchable: true - 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: readWrite - required: false - idcsSearchable: true - 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 value of the Resource attribute is persisted

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

Optional meta

meta: model.Meta

Optional multiValued

multiValued: undefined | false | true

Indicates the attribute's plurality

*SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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 - idcsSearchable: true - type: string - uniqueness: none

Optional name

name: undefined | string

Attribute's name

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

Optional ocid

ocid: undefined | string

Unique OCI identifier for the SCIM Resource.

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

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 - idcsSearchable: true - 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 - idcsSearchable: true - returned: default - type: boolean

Optional resourceType

resourceType: undefined | string

ResourceType this attribute belongs to.

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

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 - idcsSearchable: true - type: string - uniqueness: none

schemas

schemas: Array<string>

REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

Optional tags

tags: Array<Tags>

A list of tags on this resource.

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

Optional tenancyOcid

tenancyOcid: undefined | string

OCI Tenant Id (ocid) in which the resource lives.

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

Optional type

type: Type

The attribute's data type--for example, String

*SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - 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 the uniqueness of \"none\".

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

Functions

getDeserializedJsonObj

getJsonObj