1. REST API for Oracle Identity Cloud Service
  2. Tasks
  3. Common
  4. Schemas

Update a Schema Def

patch

/admin/v1/Schemas/{id}

Request

Supported Media Types
Path Parameters
Header Parameters
  • The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
  • Media Type
  • An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Body ()
Update the Schema with SCIM Patch schema.

Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute.

  • Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable:

    • The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly.
    • The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly.
    • Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below:

  • Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always:

    • If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always.
    • If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always.
    • The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

Root Schema : PatchOp
Type: object
See Section 3.5.2. HTTP PATCH is an OPTIONAL server function that enables clients to update one or more attributes of a SCIM resource using a sequence of operations to "add", "remove", or "replace" values. Clients may discover service provider support for PATCH by querying the service provider configuration. The general form of the SCIM patch request is based on JavaScript Object Notation (JSON) Patch [RFC6902]. One difference between SCIM patch and JSON patch is that SCIM servers do not support array indexing and do not support [RFC6902] operation types relating to array element manipulation such as "move". A patch request, regardless of the number of operations, SHALL be treated as atomic. If a single operation encounters an error condition, the original SCIM resource MUST be restored, and a failure status SHALL be returned.
Show Source
  • Operations
    The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
  • schemas
    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. 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. REQUIRED.
Nested Schema : Operations
Type: array
The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
Show Source
  • Operations
    Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See Section 3.5.2 for details.
Nested Schema : schemas
Type: array
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. 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. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]
Show Source
Nested Schema : Operations
Type: object
Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See Section 3.5.2 for details.
Show Source
  • Allowed Values: [ "add", "remove", "replace" ]
    Defines the operation to be performed for this Patch. If op=remove, value is not required.
  • String containing an attribute path describing the target of the operation. The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations. See Section 3.5.2 for details
  • The value could be either a simple value attribute e.g. string or number OR complex like map of the attributes to be added or replaced OR multivalues complex attributes.q1
Back to Top

Response

Supported Media Types

200 Response

The request was successful.
Body ()
Root Schema : Schema
Type: object
SCIM schema
Show Source
  • attributes
    SCIM++ Properties:
    • idcsCompositeKey: []
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A complex type that specifies the set of Resource attributes
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Schema's human-readable description
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema can be used for mapping with external identity sources such as AD or LDAP
  • Added In: 2209122038

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName
  • Added In: 2102181953

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the dataprovider mapping from resource schema should override from common schema with the same name.
  • idcsResourceTypes
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Resource types defs this resource refers to
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Schema's human-readable name
Nested Schema : attributes
Type: array
SCIM++ Properties:
  • idcsCompositeKey: []
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
A complex type that specifies the set of Resource attributes
Show Source
Nested Schema : idcsResourceTypes
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Resource types defs this resource refers to
Show Source
Nested Schema : attributes
Type: object
A complex type that specifies the set of Resource attributes
Show Source
  • canonicalValues
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the String attribute is case-sensitive
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute's human-readable description
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been added since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been added since version
  • Added In: 2106170416

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Set this attribute to True if the resource is eligibal for update while system is in readonly mode.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    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: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether changes to this attribute value are audited
  • Maximum Length: 8
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Sequence tracking ID name for the attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Display name for the canonical value attribute name.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Filter to use when getting canonical values for this schema attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Source key attribute for the canonical value.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type 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
    Specifies the Resource type ID to read from for dynamic canonical values
  • Allowed Values: [ "dynamic", "static" ]
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Type of the canonical value.
  • idcsComplexAttributeNameMappings
    SCIM++ Properties:
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g. email => emails[work].value)
  • idcsCompositeKey
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute defining the CSV header name for import/export
  • idcsCsvAttributeNameMappings
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Csv meta data for those resource type attributes which can be imported / exported from / to csv.
  • Added In: 18.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the default value for an attribute. The value must be one from canonicalValues if defined.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been deprecated since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been deprecated since version
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the user-friendly displayable attribute name or catalog key used for localization
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Localized schema attribute display name for use by UI client for displaying attribute labels
  • Added In: 2104150946

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: never
    • type: boolean
    Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.
  • idcsFeatures
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    The list of features that require this attribute
  • 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.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute value was generated
  • Allowed Values: [ "string", "long", "char", "double", "float", "integer", "boolean", "bytes", "bigdecimal", "biginteger", "guardedbytes", "guardedstring" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Maps to ICF data type
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Maps to ICF target attribute name
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Metadata to identify the ICF required attribute
  • Added In: 2104220644

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether the readOnly and immutable reference attributes should be ignored when forceDelete=true.
  • idcsIndirectRefResourceAttributes
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the indirectly referenced Resources
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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.
  • Added In: 2209122038

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum length of the attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum value of the integer attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum length of the attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum value of the integer attribute
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.
  • idcsOptionalPiiCanonicalValues
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A subset of \"canonicalValues\" that are not supported when the \"optionalPii\" feature is disabled in GlobalConfig.
  • Added In: 2102181953

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the attribute from resource schema should override from common schema with the same name.
  • Added In: 2202230830

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Set this attribute to True if the pagination is required on an attribute.
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    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.
  • Deprecated Since: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the referenced Resource attribute
  • idcsRefResourceAttributes
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the directly referenced Resources
  • Added In: 2209220956

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: never
    • type: boolean
    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: default
    • type: boolean
    • uniqueness: none
    If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.
  • Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema should be hidden externally
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the value of the attribute should be sanitized using OWASP library for HTML content
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Indicates if the attribute is scim compliant, default is true
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute can be included in a search filter
  • Allowed Values: [ "encrypt", "hash", "hash_sc", "checksum", "none" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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
    Target attribute name that this attribute gets 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
    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
    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.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target index name created for this attribute for performance
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Trims any leading and trailing blanks from String values. Default is True.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    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: 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: boolean
    Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.
  • Allowed Values: [ "inputtext", "checkbox", "textarea", "combobox" ]
    Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Validate payload reference value during create, replace, and update. Default is True.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the value of the Resource attribute is persisted
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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
  • localizedCanonicalValues
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A collection of Localized canonical values.
  • localizedDisplayName
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Attribute's localized display name
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates the attribute's plurality
  • Allowed Values: [ "readOnly", "readWrite", "immutable", "writeOnly" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the attribute is mutable
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute's name
  • referenceTypes
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the attribute is required
  • Allowed Values: [ "always", "never", "default", "request" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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
  • subAttributes
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    A list specifying the contained attributes
  • Allowed Values: [ "string", "complex", "boolean", "decimal", "integer", "dateTime", "reference", "binary" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute's data type--for example, String
  • Allowed Values: [ "none", "server", "global" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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\".
Nested Schema : canonicalValues
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \"work\", \"home\".
Show Source
Nested Schema : idcsComplexAttributeNameMappings
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g. email => emails[work].value)
Show Source
Nested Schema : idcsCompositeKey
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
The set of one or more sub attributes' names of a CMVA, whose values uniquely identify an instance of a CMVA
Show Source
Nested Schema : idcsCsvAttributeNameMappings
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Csv meta data for those resource type attributes which can be imported / exported from / to csv.
Show Source
Nested Schema : idcsFeatures
Type: array
Deprecated Since: 19.1.6

SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
The list of features that require this attribute
Allowed Values: [ "optionalPii", "mfa", "social", "schemaCustomization" ]
Show Source
Nested Schema : idcsIndirectRefResourceAttributes
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
Specifies the indirectly referenced Resources
Show Source
Nested Schema : idcsOptionalPiiCanonicalValues
Type: array
Deprecated Since: 19.1.6

SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
A subset of \"canonicalValues\" that are not supported when the \"optionalPii\" feature is disabled in GlobalConfig.
Show Source
Nested Schema : idcsRefResourceAttributes
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
Specifies the directly referenced Resources
Show Source
Nested Schema : localizedCanonicalValues
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
A collection of Localized canonical values.
Show Source
Nested Schema : localizedDisplayName
Type: object
SCIM++ Properties:
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Attribute's localized display name
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Locale used
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Localized display value
Nested Schema : referenceTypes
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
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.
Show Source
Nested Schema : subAttributes
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
A list specifying the contained attributes
Show Source
Nested Schema : idcsComplexAttributeNameMappings
Type: object
Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g. email => emails[work].value)
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes that is mapped should be hidden externally
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The attribute that is mapped to the attribute mapping
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The attribute that represents the display name
Nested Schema : idcsCsvAttributeNameMappings
Type: object
Csv meta data for those resource type attributes which can be imported / exported from / to csv.
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The CSV column header name that maps to this attribute.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    This specifies the Csv Header for resolving Resource Type for this Column Header
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The default value to be used during import processing in case the CSV column header is not present or value is not given in the import CSV.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The deprecated CSV column header name that maps to this attribute.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute path that the CSV column header name maps to for complex multi-valued attributes.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    If values of the CSV column header name can contain multiple values, this attribute specifies the delimiter to be used. For example, Group's \"User Members\" CSV column header is multi-valued and it's delimiter is a semi-colon (\";\").
  • referencedResourceTypeUniqueAttributeNameMappings
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    This attribute specifies the mapping of \"uniqueAttributeNameForDisplay\" attributes(s) of the referenced resource with the columnHeaderName(s). This attribute should be given in the idcsCsvAttributeNameMappings when uniqueAttributeNameForDisplay contains more than one attribute.
  • resolveValueUsingResourceType
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    This attribute gives a maps for resolving Resource Type after reading it's value from \"csvColumnForResolvingResourceType\" attribute
Nested Schema : referencedResourceTypeUniqueAttributeNameMappings
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
This attribute specifies the mapping of \"uniqueAttributeNameForDisplay\" attributes(s) of the referenced resource with the columnHeaderName(s). This attribute should be given in the idcsCsvAttributeNameMappings when uniqueAttributeNameForDisplay contains more than one attribute.
Show Source
  • referencedResourceTypeUniqueAttributeNameMappings
    This attribute specifies the mapping of "uniqueAttributeNameForDisplay" attributes(s) of the referenced resource with the columnHeaderName(s). This attribute should be given in the idcsCsvAttributeNameMappings when uniqueAttributeNameForDisplay contains more than one attribute.
Nested Schema : resolveValueUsingResourceType
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
This attribute gives a maps for resolving Resource Type after reading it's value from \"csvColumnForResolvingResourceType\" attribute
Show Source
Nested Schema : referencedResourceTypeUniqueAttributeNameMappings
Type: object
This attribute specifies the mapping of "uniqueAttributeNameForDisplay" attributes(s) of the referenced resource with the columnHeaderName(s). This attribute should be given in the idcsCsvAttributeNameMappings when uniqueAttributeNameForDisplay contains more than one attribute.
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the CSV column header name that maps to the corresponding \"uniqueAttributeNameForDisplay\" attribute of the resource.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the name of the attribute given in \"uniqueAttributeNameForDisplay\" in the Resource type definition.
Nested Schema : resolveValueUsingResourceType
Type: object
This attribute gives a maps for resolving Resource Type after reading it's value from "csvColumnForResolvingResourceType" attribute
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type with which the value given in \"valueToBeResolved\" attribute should be resolved
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the value which should be resolved by a Resource type.
Nested Schema : localizedCanonicalValues
Type: object
A collection of Localized canonical values.
Show Source
  • canonicalValue
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Canonical values
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Locale used
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Localized display value
Nested Schema : canonicalValue
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Canonical values
Show Source
Nested Schema : subAttributes
Type: object
A list specifying the contained attributes
Show Source
  • canonicalValues
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the String attribute is case-sensitive
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute's human-readable description
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been added since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been added since version
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    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: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether changes to this attribute value will be audited
  • Added In: 17.4.4

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Display name for the canonical value attribute name.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Filter to use when getting canonical values for this schema attribute
  • Added In: 17.4.4

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Source key attribute for the canonical value.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the Resource type 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
    Specifies the Resource type ID to read from for dynamic canonical values
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute that defines the CSV header name for import/export
  • Added In: 18.1.6

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the default value for an attribute. The value must be one from canonicalValues if defined.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates that the schema has been deprecated since this release number
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Indicates that the schema has been deprecated since version
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the user-friendly displayable attribute name or catalog key used for localization
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Localized schema attribute display name for use by UI client for displaying attribute labels
  • Added In: 2104150946

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: never
    • type: boolean
    Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute value was generated
  • idcsIndirectRefResourceAttributes
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the indirectly referenced Resources
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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: integer
    Specifies the maximum length of this attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the maximum value of the integer attribute
  • 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.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum length of this attribute
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: integer
    Specifies the minimum value of the integer attribute
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    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
    If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.
  • Added In: 18.3.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    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.
  • idcsRefResourceAttributes
    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Specifies the directly referenced Resources
  • Added In: 2209220956

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: never
    • type: boolean
    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: 2205120021

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.
  • Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the attributes in this schema can be displayed externally
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies if the value of the attribute should be sanitized using OWASP library for HTML content
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Indicates if the attribute is scim compliant, default is true
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether this attribute can be included in a search filter
  • Allowed Values: [ "encrypt", "hash", "hash_sc", "checksum", "none" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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
    Target attribute name that this attribute gets 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
    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
    • returned: default
    • type: string
    • uniqueness: none
    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.
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Target index name created for this attribute for performance
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    Trims any leading and trailing blanks from String values. Default is True.
  • Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    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: 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: boolean
    Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.
  • Allowed Values: [ "inputtext", "checkbox", "textarea", "combobox" ]
    Added In: 17.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Validate payload reference value during create, replace, and update. Default is True.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies whether the sub-attribute of the Resource attribute is persisted
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    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
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates the attribute's plurality
  • Allowed Values: [ "readOnly", "readWrite", "immutable", "writeOnly" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the attribute is mutable
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute's name
  • referenceTypes
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Specifies if the attribute is required
  • Allowed Values: [ "always", "never", "default", "request" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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
  • Allowed Values: [ "string", "complex", "boolean", "decimal", "integer", "dateTime", "reference", "binary" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute's data type--for example, String
  • Allowed Values: [ "none", "server", "global" ]
    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    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\".
Nested Schema : canonicalValues
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \"work\", \"home\".
Show Source
Nested Schema : idcsIndirectRefResourceAttributes
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
Specifies the indirectly referenced Resources
Show Source
Nested Schema : idcsRefResourceAttributes
Type: array
SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
Specifies the directly referenced Resources
Show Source
Nested Schema : referenceTypes
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
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.
Show Source

400 Response

Bad or invalid request
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

401 Response

The supplied credentials, if any, are not sufficient to access the resource.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

404 Response

The requested resource was not found.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

500 Response

We couldn't return the representation due to an internal server error.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
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 SCIM specified Error and Extn Error Schema. 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. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
Back to Top

Examples

The following example shows how to update values for a schema by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use. 
curl
-X PATCH
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/Schemas/<ID>

Example of Request Body

The following shows an example of the request body in JSON format:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [{
            "op": "add",
            "path": "attributes",
            "value": [
                {
                    "idcsValuePersisted": true,
                    "uniqueness": "none",
                    "name": "hobbies",
                    "idcsDisplayName": "Hobbies",
                    "description": "Hobbies",
                    "required": false,
                    "type": "string",
                    "idcsMinLength": 3,
                    "idcsMaxLength": 200,
                    "idcsAuditable": false,
                    "caseExact": true,
                    "returned": "default",
                    "idcsSearchable": true,
                    "multiValued": true 
                }]
        }]
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "name": "CustomUser",
    "description": "Custom User",
    "id": "urn:ietf:params:scim:schemas:idcs:extension:custom:User",
    "idcsResourceTypes": [
        "User"
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "meta": {
        "resourceType": "Schema",
        "created": "2018-04-09T12:58:28.026Z",
        "lastModified": "2018-04-09T13:20:40.720Z",
        "location": "https://tenant-base-url/admin/v1/Schemas/urn:ietf:params:scim:schemas:idcs:extension:custom:User"
    },
    "idcsCreatedBy": {
        "value": "b2e4000e3b6e4fd89bb521e10d294d18",
        "type": "App",
        "display": "idcssm",
        "$ref": "https://tenant-base-url/admin/v1/Apps/b2e4000e3b6e4fd89bb521e10d294d18"
    },
    "idcsLastModifiedBy": {
        "value": "b2e4000e3b6e4fd89bb521e10d294d18",
        "type": "App",
        "display": "admin",
        "$ref": "https://tenant-base-url/admin/v1/Apps/b2e4000e3b6e4fd89bb521e10d294d18"
    },
    "attributes": [
        {
            "uniqueness": "none",
            "name": "hobbies",
            "idcsDisplayName": "Hobbies",
            "description": "Hobbies",
            "required": false,
            "type": "string",
            "idcsMinLength": 3,
            "idcsMaxLength": 200,
            "caseExact": true,
            "returned": "default",
            "idcsSearchable": true,
            "multiValued": true
        }
    ]
}
Back to Top