Search Schemas Using POST
post
/admin/v1/Schemas/.search
Request
Supported Media Types
- application/scim+json
- application/json
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.
Root Schema : Schema-SearchRequest
Type:
object
Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the /.search path extension. The inclusion of /.search on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in /.search). The body of the POST request MAY include any of the parameters.
Show Source
-
attributes(optional):
array attributes
A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.
-
attributeSets(optional):
array attributeSets
A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.
-
count(optional):
integer
Minimum Length:
1
Maximum Length:1000
An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). 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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.
-
sortBy(optional):
string
A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation (Section 3.10) form. See Sorting section. OPTIONAL.
-
sortOrder(optional):
string
Allowed Values:
[ "ascending", "descending" ]
A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See (Sorting Section). OPTIONAL. -
startIndex(optional):
integer
An integer that indicates the 1-based index of the first query result. See Pagination Section. OPTIONAL.
Nested Schema : attributes
Type:
array
A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.
Show Source
Nested Schema : attributeSets
Type:
array
A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.
Allowed Values:
Show Source
[
"all",
"always",
"never",
"request",
"default"
]
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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:SearchRequest"
]
Response
Supported Media Types
- application/json
- application/scim+json
200 Response
The request was successful.
Root Schema : Schema-ListResponse
Type:
object
The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI.
Show Source
-
itemsPerPage:
integer
The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.
-
Resources:
array Resources
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
-
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. 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.
-
startIndex:
integer
The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.
-
totalResults:
integer
The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED.
Nested Schema : Resources
Type:
array
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
Show Source
-
Array of:
object Schema
SCIM schema
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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
Nested 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
-
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
-
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
-
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
-
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 OCI IAM 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 OCI IAM 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
-
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.
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
-
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.
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
-
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 could not be 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.
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
-
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.
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
-
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.