Get a Schema
get
/admin/v1/Schemas/{id}
Request
Path Parameters
-
id: string
ID of the resource
Header Parameters
-
Authorization: string
The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
-
Content-Type: string
Media Type
-
RESOURCE_TYPE_SCHEMA_VERSION(optional): string
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.
Response
Supported Media Types
- application/json
- application/scim+json
200 Response
The request was successful.
Root Schema : Schema
Type:
object
SCIM schema
Show Source
-
attributes(optional):
array attributes
SCIM++ Properties:
- idcsCompositeKey: []
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
description(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsAttributeCacheable(optional):
boolean
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsMappable:
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
idcsMapsToSameTargetAttributeNameAs(optional):
string
Added In: 2209122038
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
- uniqueness: none
-
idcsOverrideCommonAttribute(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsResourceTypes(optional):
array idcsResourceTypes
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
name(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : attributes
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: []
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object attributes
A complex type that specifies the set of Resource attributes
Nested Schema : idcsResourceTypes
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : attributes
Type:
object
A complex type that specifies the set of Resource attributes
Show Source
-
canonicalValues(optional):
array canonicalValues
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
caseExact(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
description(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsAddedSinceReleaseNumber(optional):
string
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsAddedSinceVersion(optional):
integer
Deprecated Since: 19.3.3
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsAllowUpdatesInReadOnlyMode(optional):
boolean
Added In: 2106170416
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsAttributeCacheable(optional):
boolean
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsAttributeMappable(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsAuditable(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsAutoIncrementSeqName(optional):
string
Maximum Length:
8
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsCanonicalValueSourceDisplayAttrName(optional):
string
Added In: 17.4.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceFilter(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceKeyAttrName(optional):
string
Added In: 17.4.6
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceResourceType(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceResourceTypeID(optional):
string
Added In: 17.4.6
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueType(optional):
string
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
-
idcsComplexAttributeNameMappings(optional):
array idcsComplexAttributeNameMappings
SCIM++ Properties:
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
idcsCompositeKey(optional):
array idcsCompositeKey
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCsvAttributeName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCsvAttributeNameMappings(optional):
array idcsCsvAttributeNameMappings
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
idcsDefaultValue(optional):
string
Added In: 18.1.6
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsDeprecatedSinceReleaseNumber(optional):
string
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsDeprecatedSinceVersion(optional):
integer
Deprecated Since: 19.3.3
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsDisplayName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsDisplayNameMessageId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsExcludeFromUpgradePatch(optional):
boolean
Added In: 2104150946
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: boolean
-
idcsFeatures(optional):
array idcsFeatures
Deprecated Since: 19.1.6
SCIM++ Properties:- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsFetchComplexAttributeValues(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsFromTargetMapper(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsGenerated(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsICFAttributeType(optional):
string
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
-
idcsICFBundleAttributeName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsICFRequired(optional):
boolean
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsIgnoreReadOnlyAndImmutableRefAttrsDuringForceDelete(optional):
boolean
Added In: 2104220644
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsIndirectRefResourceAttributes(optional):
array idcsIndirectRefResourceAttributes
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsInternal(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsMapsToSameTargetAttributeNameAs(optional):
string
Added In: 2209122038
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
- uniqueness: none
-
idcsMaxLength(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsMaxValue(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
-
idcsMinLength(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsMinValue(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
-
idcsMultiLanguage(optional):
boolean
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsOptionalPiiCanonicalValues(optional):
array idcsOptionalPiiCanonicalValues
Deprecated Since: 19.1.6
SCIM++ Properties:- caseExact: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsOverrideCommonAttribute(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsPaginateResponse(optional):
boolean
Added In: 2202230830
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsPii(optional):
boolean
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsRefResourceAttribute(optional):
string
Deprecated Since: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsRefResourceAttributes(optional):
array idcsRefResourceAttributes
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsRequiresImmediateReadAfterWriteForAccessFlows(optional):
boolean
Added In: 2209220956
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: boolean
-
idcsRequiresWriteForAccessFlows(optional):
boolean
Added In: 2209220956
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsRtsaHideAttribute(optional):
boolean
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsSanitize(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsScimCompliant(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsSearchable(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsSensitive(optional):
string
Allowed Values:
[ "encrypt", "hash", "hash_sc", "checksum", "none" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetAttributeName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetAttributeNameToMigrateFrom(optional):
string
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetNormAttributeName(optional):
string
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetUniqueConstraintName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsToTargetMapper(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTrimStringValue(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsuiOrder(optional):
integer
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsuiRegexp(optional):
string
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsuiVisible(optional):
boolean
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsuiWidget(optional):
string
Allowed Values:
[ "inputtext", "checkbox", "textarea", "combobox" ]
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsValidateReference(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsValuePersisted(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsValuePersistedInOtherAttribute(optional):
boolean
Added In: 18.2.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
localizedCanonicalValues(optional):
array localizedCanonicalValues
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
localizedDisplayName(optional):
object localizedDisplayName
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
multiValued(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
mutability(optional):
string
Allowed Values:
[ "readOnly", "readWrite", "immutable", "writeOnly" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
name(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
referenceTypes(optional):
array referenceTypes
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
required(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
returned(optional):
string
Allowed Values:
[ "always", "never", "default", "request" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
subAttributes(optional):
array subAttributes
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
type(optional):
string
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
-
uniqueness(optional):
string
Allowed Values:
[ "none", "server", "global" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : canonicalValues
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsComplexAttributeNameMappings
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
Array of:
object idcsComplexAttributeNameMappings
Specifies the mapping between external identity source attributes and Oracle Identity Cloud Service complex attributes (e.g. email => emails[work].value)
Nested Schema : idcsCompositeKey
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsCsvAttributeNameMappings
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object idcsCsvAttributeNameMappings
Csv meta data for those resource type attributes which can be imported / exported from / to csv.
Nested Schema : idcsFeatures
Type:
array
Deprecated Since: 19.1.6
SCIM++ Properties:
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
Allowed Values:
Show Source
[
"optionalPii",
"mfa",
"social",
"schemaCustomization"
]
Nested Schema : idcsIndirectRefResourceAttributes
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
Nested Schema : idcsOptionalPiiCanonicalValues
Type:
array
Deprecated Since: 19.1.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsRefResourceAttributes
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
Nested Schema : localizedCanonicalValues
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object localizedCanonicalValues
A collection of Localized canonical values.
Nested Schema : localizedDisplayName
Type:
object
SCIM++ Properties:
Show Source
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
locale(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : referenceTypes
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : subAttributes
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object subAttributes
A list specifying the contained attributes
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
-
idcsRtsaHideAttribute(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
mapsTo:
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
name:
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsCsvAttributeNameMappings
Type:
object
Csv meta data for those resource type attributes which can be imported / exported from / to csv.
Show Source
-
columnHeaderName(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
csvColumnForResolvingResourceType(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
defaultValue(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
deprecatedColumnHeaderName(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
mapsTo(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
multiValueDelimiter(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
referencedResourceTypeUniqueAttributeNameMappings(optional):
array referencedResourceTypeUniqueAttributeNameMappings
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
resolveValueUsingResourceType(optional):
array resolveValueUsingResourceType
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : referencedResourceTypeUniqueAttributeNameMappings
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object 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:
Show Source
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object resolveValueUsingResourceType
This attribute gives a maps for resolving Resource Type after reading it's value from "csvColumnForResolvingResourceType" attribute
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
-
mapsFromColumnName(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
resourceTypeAttributeName(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : resolveValueUsingResourceType
Type:
object
This attribute gives a maps for resolving Resource Type after reading it's value from "csvColumnForResolvingResourceType" attribute
Show Source
-
resolveBy(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
valueToBeResolved(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : localizedCanonicalValues
Type:
object
A collection of Localized canonical values.
Show Source
-
canonicalValue(optional):
array canonicalValue
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
locale(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : canonicalValue
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : subAttributes
Type:
object
A list specifying the contained attributes
Show Source
-
canonicalValues(optional):
array canonicalValues
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
caseExact(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
description(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsAddedSinceReleaseNumber(optional):
string
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsAddedSinceVersion(optional):
integer
Deprecated Since: 19.3.3
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsAttributeCacheable(optional):
boolean
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsAttributeMappable(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsAuditable(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsCanonicalValueSourceDisplayAttrName(optional):
string
Added In: 17.4.4
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceFilter(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceKeyAttrName(optional):
string
Added In: 17.4.4
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceResourceType(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCanonicalValueSourceResourceTypeID(optional):
string
Added In: 17.4.4
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsCsvAttributeName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsDefaultValue(optional):
string
Added In: 18.1.6
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsDeprecatedSinceReleaseNumber(optional):
string
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsDeprecatedSinceVersion(optional):
integer
Deprecated Since: 19.3.3
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsDisplayName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsDisplayNameMessageId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsExcludeFromUpgradePatch(optional):
boolean
Added In: 2104150946
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: boolean
-
idcsFromTargetMapper(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsGenerated(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsIndirectRefResourceAttributes(optional):
array idcsIndirectRefResourceAttributes
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsInternal(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsMaxLength(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsMaxValue(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
-
idcsMaxValuesReturned(optional):
integer
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
- uniqueness: none
-
idcsMinLength(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsMinValue(optional):
integer
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
-
idcsOneValueMustBeTrue(optional):
boolean
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsOnlyOneValueCanBeTrue(optional):
boolean
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsPii(optional):
boolean
Added In: 18.3.6
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsRefResourceAttributes(optional):
array idcsRefResourceAttributes
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsRequiresImmediateReadAfterWriteForAccessFlows(optional):
boolean
Added In: 2209220956
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: boolean
-
idcsRequiresWriteForAccessFlows(optional):
boolean
Added In: 2205120021
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsRtsaHideAttribute(optional):
boolean
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsSanitize(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsScimCompliant(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsSearchable(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsSensitive(optional):
string
Allowed Values:
[ "encrypt", "hash", "hash_sc", "checksum", "none" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetAttributeName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetAttributeNameToMigrateFrom(optional):
string
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetNormAttributeName(optional):
string
Added In: 19.1.4
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTargetUniqueConstraintName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsToTargetMapper(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsTrimStringValue(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
-
idcsuiOrder(optional):
integer
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
idcsuiRegexp(optional):
string
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsuiVisible(optional):
boolean
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsuiWidget(optional):
string
Allowed Values:
[ "inputtext", "checkbox", "textarea", "combobox" ]
Added In: 17.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
idcsValidateReference(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsValuePersisted(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
idcsValuePersistedInOtherAttribute(optional):
boolean
Added In: 18.2.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
multiValued(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
mutability(optional):
string
Allowed Values:
[ "readOnly", "readWrite", "immutable", "writeOnly" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
name(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
referenceTypes(optional):
array referenceTypes
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
required(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
returned(optional):
string
Allowed Values:
[ "always", "never", "default", "request" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
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
-
uniqueness(optional):
string
Allowed Values:
[ "none", "server", "global" ]
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : canonicalValues
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsIndirectRefResourceAttributes
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
Nested Schema : idcsRefResourceAttributes
Type:
array
SCIM++ Properties:
Show Source
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
Nested Schema : referenceTypes
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
400 Response
Bad or invalid request
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
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.
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array 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.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object 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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
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.
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
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.
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array 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.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object 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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
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.
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
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.
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array 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.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object 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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
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.
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
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.
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array 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.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object 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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
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.
Examples
The following example shows how to retrieve a schema using its ID by submitting a GET 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 structurehttps://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 GET
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/Schemas/<ID>
For Example: https://tenant-base-url/admin/v1/Schemas/urn:ietf:params:scim:schemas:oracle:idcs:Settings
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"id": "urn:ietf:params:scim:schemas:oracle:idcs:Settings",
"description": "Settings schema",
"name": "Settings",
"attributes": [
{
"name": "id",
"type": "string",
"multiValued": false,
"description": "The unique URI of the schema.",
"required": true,
"caseExact": false,
"mutability": "readOnly",
"returned": "always",
"uniqueness": "global"
},
{
"name": "externalId",
"type": "string",
"multiValued": false,
"description": "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 be 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.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "contactEmails",
"type": "string",
"multiValued": true,
"description": "contact emails used to notify tenants. Can be one or more user or group alias emails.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "customBranding",
"type": "boolean",
"multiValued": false,
"description": "A boolean value indicating if default or custom branding.",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "preferredLanguage",
"type": "string",
"multiValued": false,
"description": "preferred written or spoken language used for localized user interfaces",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"idaasMaxLength": 50,
"idaasCanonicalValueSourceResourceType": "AllowedValue",
"idaasCanonicalValueSourceFilter": "attrName eq \"languages\" and attrValues.value eq \"$(preferredLanguage)\""
},
{
"name": "timezone",
"type": "string",
"multiValued": false,
"description": "User's timezone",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"idaasMaxLength": 50,
"idaasCanonicalValueSourceResourceType": "AllowedValue",
"idaasCanonicalValueSourceFilter": "attrName eq \"timezones\" and attrValues.value eq \"$(timezone)\""
},
{
"name": "locale",
"type": "string",
"multiValued": false,
"description": "default location for purposes of localizing items such as currency, date time format, numerical representations, etc.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"idaasMaxLength": 50,
"idaasCanonicalValueSourceResourceType": "AllowedValue",
"idaasCanonicalValueSourceFilter": "attrName eq \"locales\" and attrValues.value eq \"$(locale)\""
},
{
"name": "companyNames",
"type": "complex",
"multiValued": true,
"description": "name of the company in different locales",
"required": false,
"idaasMaxLength": 50,
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "company name.",
"required": true,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "locale",
"type": "string",
"multiValued": false,
"description": "locale value.",
"required": true,
"mutability": "readWrite",
"returned": "default",
"idaasCanonicalValueSourceResourceType": "AllowedValue",
"idaasCanonicalValueSourceFilter": "attrName eq \"locales\" and attrValues.value eq \"$(companyNames.locale)\""
}
],
"mutability": "readWrite",
"returned": "default"
},
{
"name": "loginTexts",
"type": "complex",
"multiValued": true,
"description": "login text in different locales",
"required": false,
"idaasMaxLength": 250,
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "loing text.",
"required": true,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "locale",
"type": "string",
"multiValued": false,
"description": "locale value.",
"required": true,
"mutability": "readWrite",
"returned": "default",
"idaasCanonicalValueSourceResourceType": "AllowedValue",
"idaasCanonicalValueSourceFilter": "attrName eq \"locales\" and attrValues.value eq \"$(loginTexts.locale)\""
}
],
"mutability": "readWrite",
"returned": "default"
},
{
"name": "images",
"type": "complex",
"multiValued": true,
"description": "References to various images",
"required": false,
"subAttributes": [
{
"name": "value",
"type": "reference",
"referenceTypes": [
"uri"
],
"multiValued": false,
"description": "URI of the image.",
"required": true,
"mutability": "readWrite",
"returned": "default"
},
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "A label indicating the type of the image.",
"required": true,
"canonicalValues": [
"desktop logo",
"mobile logo",
"desktop portal header",
"mobile portal header",
"email header",
"email footer"
],
"mutability": "readWrite",
"returned": "default"
},
{
"name": "display",
"type": "string",
"multiValued": false,
"description": "A human readable name, primarily used for display purposes",
"required": false,
"mutability": "readWrite",
"returned": "default"
}
],
"mutability": "readWrite",
"returned": "default"
},
{
"name": "diagnosticLevel",
"type": "integer",
"multiValued": false,
"description": "The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic-logging is disabled. A level of 1 (one) indicates that diagnostic-logging is enabled.",
"required": false,
"caseExact": false,
"idaasSearchable": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "diagnosticTracingUpto",
"type": "dateTime",
"multiValued": false,
"description": "The end time upto which diagnostic recording is switched on.",
"required": false,
"caseExact": false,
"idaasSearchable": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "allowedDomains",
"type": "string",
"multiValued": true,
"description": "One or more email domains allowed in a user's email field. If unassigned, any domain is allowed",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"caseExact": false,
"description": "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. REQUIRED.",
"idaasSearchable": false,
"idaasTargetAttributeName": "",
"multiValued": true,
"mutability": "readWrite",
"name": "schemas",
"required": true,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": false,
"description": "A complex attribute containing resource metadata. All sub-attributes are OPTIONAL",
"idaasSearchable": true,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "meta",
"required": false,
"returned": "default",
"subAttributes": [
{
"caseExact": false,
"description": "The name of the resource type of the resource, e.g. Users or Groups.",
"idaasSearchable": false,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "resourceType",
"required": false,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": false,
"description": "The DateTime the Resource was added to the Service Provider.",
"idaasSearchable": true,
"idaasTargetAttributeName": "createtimestamp",
"multiValued": false,
"mutability": "readOnly",
"name": "created",
"required": false,
"returned": "default",
"type": "dateTime",
"uniqueness": "none"
},
{
"caseExact": false,
"description": "The most recent DateTime the details of this resource were updated at the service provider. If this resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.",
"idaasSearchable": true,
"idaasTargetAttributeName": "modifytimestamp",
"multiValued": false,
"mutability": "readOnly",
"name": "lastModified",
"required": false,
"returned": "default",
"type": "dateTime",
"uniqueness": "none"
},
{
"caseExact": false,
"description": "The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.",
"idaasSearchable": false,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "location",
"required": false,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": false,
"description": "The version of the Resource being returned. This value must be the same as the ETag HTTP response header.",
"idaasSearchable": false,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "version",
"required": false,
"returned": "default",
"type": "string",
"uniqueness": "none"
}
],
"type": "complex"
},
{
"description": "The User id or OAuthClient who created the resource.",
"idaasSearchable": true,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "idaasCreatedBy",
"required": true,
"returned": "default",
"idaasValidateReference": false,
"subAttributes": [
{
"caseExact": true,
"description": "The id of the SCIM resource representing the User or OAuthClient who created this resource.",
"idaasSearchable": true,
"idaasTargetAttributeName": "idcsCreatorId",
"multiValued": false,
"mutability": "readOnly",
"name": "value",
"required": true,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": true,
"description": "The URI of the SCIM resource representing the User or OAuthClient who created this resource.",
"idaasSearchable": false,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "$ref",
"referenceTypes": [
"User",
"OAuthClient"
],
"required": false,
"returned": "default",
"type": "reference",
"uniqueness": "none",
"idaasValuePersisted": false
},
{
"canonicalValues": [
"User",
"OAuthClient"
],
"caseExact": false,
"description": "The type of resource, User or OAuthClient, that created this resource.",
"idaasTargetAttributeName": "idcsCreatorType",
"idaasDisplayName": "Type",
"idaasSearchable": false,
"multiValued": false,
"mutability": "readOnly",
"name": "type",
"required": true,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": true,
"description": "The displayName of the User or OAuthClient who created this resource",
"idaasSearchable": false,
"idaasTargetAttributeName": "idcsCreatorDisplayName",
"multiValued": false,
"mutability": "readOnly",
"name": "display",
"required": false,
"returned": "default",
"type": "string",
"uniqueness": "none"
}
],
"type": "complex"
},
{
"description": "The User id or OAuthClient who modified the resource.",
"idaasSearchable": true,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "idaasLastModifiedBy",
"required": false,
"returned": "default",
"idaasValidateReference": false,
"subAttributes": [
{
"caseExact": true,
"description": "The id of the SCIM resource representing the User or OAuthClient who modified this resource.",
"idaasSearchable": true,
"idaasTargetAttributeName": "idcsModifierId",
"multiValued": false,
"mutability": "readOnly",
"name": "value",
"required": true,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": true,
"description": "The URI of the SCIM resource representing the User or OAuthClient who modified this resource.",
"idaasSearchable": false,
"idaasTargetAttributeName": "",
"multiValued": false,
"mutability": "readOnly",
"name": "$ref",
"referenceTypes": [
"User"
],
"required": false,
"returned": "default",
"type": "reference",
"uniqueness": "none",
"idaasValuePersisted": false
},
{
"canonicalValues": [
"User",
"OAuthClient"
],
"caseExact": false,
"description": "The type of resource, User or OAuthClient, that created this resource.",
"idaasTargetAttributeName": "idcsModifierType",
"idaasDisplayName": "Type",
"idaasSearchable": false,
"multiValued": false,
"mutability": "readOnly",
"name": "type",
"required": true,
"returned": "default",
"type": "string",
"uniqueness": "none"
},
{
"caseExact": true,
"description": "The displayName of the User or OAuthClient who modified this resource",
"idaasSearchable": false,
"idaasTargetAttributeName": "idcsModifierDisplayName",
"multiValued": false,
"mutability": "readOnly",
"name": "display",
"required": false,
"returned": "default",
"type": "string",
"uniqueness": "none"
}
],
"type": "complex"
}
],
"idaasCreatedBy": {
"value": "idcs",
"type": "User"
},
"idaasLastModifiedBy": {
"value": "idcs",
"type": "User"
},
"meta": {
"resourceType": "SchemaDef",
"location": "null/SchemaDefs/urn:ietf:params:scim:schemas:oracle:idcs:Settings",
"created": "2015-07-13T07:28:59.227Z",
"lastModified": "2015-07-13T07:28:59.227Z"
}
}
}