Get a Resource Type
get
/admin/v1/ResourceTypes/{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 : ResourceType
Type:
object
Resource Type
Show Source
-
bypassIAMAuthorization(optional):
boolean
Added In: 2104080501
SCIM++ Properties:- type: boolean
- multiValued: false
- required: false
- caseExact: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
description(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- caseExact: false
- mutability: readWrite
- returned: default
- uniqueness: none
-
endpoint:
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: true
- caseExact: false
- idcsSearchable: true
- mutability: readWrite
- returned: default
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- caseExact: false
- mutability: readWrite
- returned: default
- uniqueness: none
-
generateOcid(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
name:
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: true
- caseExact: false
- mutability: readWrite
- returned: always
- uniqueness: none
-
ocidResourceKind(optional):
string
Added In: 2012271618
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
- uniqueness: none
-
schema:
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: true
- caseExact: false
- mutability: readWrite
- returned: default
- uniqueness: none
-
schemaExtensions(optional):
array schemaExtensions
SCIM++ Properties:
- type: complex
- multiValued: true
- required: false
- caseExact: false
- idcsCompositeKey: [schema]
- mutability: readWrite
- returned: default
- uniqueness: none
-
updateUserReferenceOcids(optional):
boolean
Added In: 2104080501
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:idcsResourceType:ResourceType(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:idcsResourceType:ResourceType
Oracle Identity Cloud Service Resource Type
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:jdbcDataProviderParams:ResourceType(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:jdbcDataProviderParams:ResourceType
JDBC parameters.
Nested Schema : schemaExtensions
Type:
array
SCIM++ Properties:
Show Source
- type: complex
- multiValued: true
- required: false
- caseExact: false
- idcsCompositeKey: [schema]
- mutability: readWrite
- returned: default
- uniqueness: none
-
Array of:
object schemaExtensions
Resource type schema extensions
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:idcsResourceType:ResourceType
Type:
object
Oracle Identity Cloud Service Resource Type
Show Source
-
addedSinceReleaseNumber(optional):
string
Added In: 17.3.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
allowDeleteWhere(optional):
boolean
Added In: 19.1.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
allowUpdatesInReadOnlyMode(optional):
boolean
Added In: 2106170416
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
allowUpdateWhere(optional):
boolean
Added In: 19.2.1
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
anyProtectedResource(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
asyncDelete(optional):
boolean
Added In: 17.4.6
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
auditable(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
authzResourceKind(optional):
string
Added In: 2011192329
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- caseExact: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
builderClass:
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
cache(optional):
object cache
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: complex
- uniqueness: none
-
csvExportSupported(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
csvImportOperationsSupported(optional):
array csvImportOperationsSupported
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
csvImportReportDataCollectorClass(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
dataProviderClass:
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
deprecatedSinceReleaseNumber(optional):
string
Added In: 17.3.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
displayNameMessageId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
earliestSupportedSchemaVersion(optional):
integer
Deprecated Since: 19.3.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
etagSupported(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
excludedCommonAttrs(optional):
array excludedCommonAttrs
Added In: 17.4.6
SCIM++ Properties:- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
excludeFromApiDoc(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
externalJDBCDataSource(optional):
string
Added In: 20.1.3
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
externalResourceType(optional):
string
Deprecated Since: 19.1.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
featureSpecificSchemaExtensions(optional):
array featureSpecificSchemaExtensions
Deprecated Since: 19.1.6
SCIM++ Properties:- caseExact: false
- idcsCompositeKey: [schemaExtension]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
fetchResourceAfterModify(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
idcsRtsaHideExtensionSchemas(optional):
array idcsRtsaHideExtensionSchemas
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
internal(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
isTransactionSupported(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
latestSupportedSchemaVersion(optional):
integer
Deprecated Since: 19.3.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
managerClass:
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
ociAuditAttrsToGetDuringUpdate(optional):
array ociAuditAttrsToGetDuringUpdate
Added In: 2201190827
SCIM++ Properties:- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
operations(optional):
array operations
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [name]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
publishToRQS(optional):
boolean
Added In: 2105200541
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
replicable(optional):
boolean
Added In: 2101262133
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
resourcesManaged:
array resourcesManaged
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
resourceSubTypeAttributeName(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
resourceSubTypes(optional):
array resourceSubTypes
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
sanitizeAllWritableStrings(optional):
boolean
Added In: 2106240046
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
serviceName:
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
singleton:
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
sourceResourceType(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
uniqueAttributeNameForDisplay:
array uniqueAttributeNameForDisplay
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:jdbcDataProviderParams:ResourceType
Type:
object
JDBC parameters.
Show Source
-
compositeIndex(optional):
array compositeIndex
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [columns]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
hasChildTable(optional):
boolean
Added In: 2104300806
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: global
-
table:
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: global
-
template(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
- uniqueness: global
-
tenantTemplate(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: string
- uniqueness: global
Nested Schema : schemaExtensions
Type:
object
Resource type schema extensions
Show Source
-
required:
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: true
- caseExact: false
- mutability: readWrite
- returned: default
- uniqueness: none
-
schema:
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: true
- caseExact: false
- mutability: readWrite
- returned: default
- uniqueness: none
Nested Schema : cache
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: always
- type: complex
- uniqueness: none
-
attributesAffectingCacheability(optional):
array attributesAffectingCacheability
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
cacheable(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
compositeKeys(optional):
array compositeKeys
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
handler(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
localizeCacheKey(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "lasting", "transient", "tenant-near" ]
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : csvImportOperationsSupported
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"create",
"update",
"replace",
"delete"
]
Nested Schema : excludedCommonAttrs
Type:
array
Added In: 17.4.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : featureSpecificSchemaExtensions
Type:
array
Deprecated Since: 19.1.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [schemaExtension]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object featureSpecificSchemaExtensions
Deprecated Since: 19.1.6
SCIM++ Properties:- caseExact: false
- idcsCompositeKey: [schemaExtension]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : idcsRtsaHideExtensionSchemas
Type:
array
Added In: 19.1.4
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : ociAuditAttrsToGetDuringUpdate
Type:
array
Added In: 2201190827
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : operations
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [name]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object operations
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [name]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : resourcesManaged
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"tenant",
"global"
]
Nested Schema : resourceSubTypes
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : uniqueAttributeNameForDisplay
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : attributesAffectingCacheability
Type:
array
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : compositeKeys
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : featureSpecificSchemaExtensions
Type:
object
Deprecated Since: 19.1.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [schemaExtension]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
features(optional):
array features
Deprecated Since: 19.1.6
SCIM++ Properties:- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
schemaExtension:
string
Deprecated Since: 19.1.6
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : features
Type:
array
Deprecated Since: 19.1.6
SCIM++ Properties:
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"optionalPii",
"mfa",
"social",
"schemaCustomization"
]
Nested Schema : operations
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [name]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
actualReadOperation(optional):
boolean
Deprecated Since: 2205120021
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
analyze(optional):
array analyze
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
auditable(optional):
array auditable
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
authzContextVariables(optional):
array authzContextVariables
Added In: 2102181953
SCIM++ Properties:- caseExact: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
authzOperationId(optional):
string
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: global
-
cachePostProcess(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
composite(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
description(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
eventId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
excludeFromApiDoc(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
features(optional):
array features
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
globalityWriteType(optional):
string
Allowed Values:
[ "localWrite", "direct", "writeToMasterOnly" ]
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
internal(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
metric(optional):
array metric
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
metricsDisplayName(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
name:
string
Allowed Values:
[ "get", "create", "update", "replace", "delete", "search", "postSearch", "options" ]
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
notify(optional):
array notify
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
requiredForAccessFlow(optional):
boolean
Added In: 2209220956
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
subscribe(optional):
array subscribe
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : analyze
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"success",
"failure"
]
Nested Schema : auditable
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"success",
"failure"
]
Nested Schema : authzContextVariables
Type:
array
Added In: 2102181953
SCIM++ Properties:
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"target.user.name",
"target.user.id",
"target.credential.type",
"target.group.id",
"target.group.name",
"target.app.id",
"target.app.name",
"target.app.serviceType",
"consumer.app.id",
"consumer.app.name",
"consumer.app.serviceType",
"consumer.app.domain",
"consumer.app.region",
"producer.app.id",
"producer.app.name",
"producer.app.serviceType",
"producer.app.domain",
"producer.app.region",
"target.subject.type",
"target.subject.id",
"target.subject.domain",
"target.subject.name"
]
Nested Schema : features
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : metric
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"success",
"failure"
]
Nested Schema : notify
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"success",
"failure"
]
Nested Schema : subscribe
Type:
array
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"success",
"failure"
]
Nested Schema : compositeIndex
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [columns]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object compositeIndex
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [columns]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : compositeIndex
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- idcsCompositeKey: [columns]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
columns:
array columns
SCIM++ Properties:
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
unique:
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : columns
Type:
array
SCIM++ Properties:
Show Source
- caseExact: true
- multiValued: true
- mutability: readWrite
- required: true
- 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 resource type 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/ResourceTypes/<ID>
For example: https://tenant-base-url/admin/v1/ResourceTypes/User
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"description": "Manage users. You can create user accounts only if you are granted access to the Identity Domain Administrator or User Administrator role. By default, Oracle Identity Cloud Service contains one user account (admin@example.com) for the Identity Domain Administrator. This REST API is SCIM compliant.",
"endpoint": "/Users",
"id": "User",
"name": "User",
"schema": "urn:ietf:params:scim:schemas:core:2.0:User",
"schemaExtensions": [
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User"
},
{
"schema": "urn:ietf:params:scim:schemas:idcs:extension:custom:User",
"required": false
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:crossSso:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:kerberosUser:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:sff:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User"
},
{
"required": false,
"schema": "urn:ietf:params:scim:schemas:oracle:idcs:extension:socialAccount:User"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:ResourceType",
"urn:ietf:params:scim:schemas:oracle:idcs:extension:idcsResourceType:ResourceType",
"urn:ietf:params:scim:schemas:oracle:idcs:extension:jdbcDataProviderParams:ResourceType"
],
"urn:ietf:params:scim:schemas:oracle:idcs:extension:idcsResourceType:ResourceType": {
"auditable": true,
"builderClass": "oracle.idaas.identity.object.User",
"csvExportSupported": true,
"csvImportOperationsSupported": [
"create",
"update"
],
"csvImportReportDataCollectorClass": "oracle.idaas.fileimport.impl.UserJobReportDataCollector",
"dataProviderClass": "oracle.idaas.provider.jdbc.JdbcProvider",
"etagSupported": true,
"internal": false,
"managerClass": "oracle.idaas.identity.manager.api.UserManager",
"operations": [
{
"description": "Get a User",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Get Users",
"name": "get"
},
{
"description": "Create a User",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Create Users",
"name": "create"
},
{
"description": "Update a User",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Update Users",
"name": "update"
},
{
"description": "Replace a User",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Replace Users",
"name": "replace"
},
{
"auditable": [
"success",
"failure"
],
"description": "Delete a User",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Delete Users",
"name": "delete",
"subscribe": [
"success"
]
},
{
"description": "Search Users",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Search Users",
"name": "search"
},
{
"description": "Search Users Using POST",
"metric": [
"success",
"failure"
],
"metricsDisplayName": "Search Users",
"name": "postSearch"
},
{
"description": "HTTP OPTIONS Method for CORS Support",
"name": "options"
}
],
"resourcesManaged": [
"tenant"
],
"serviceName": "admin",
"singleton": false,
"uniqueAttributeNameForDisplay": [
"userName"
]
},
"urn:ietf:params:scim:schemas:oracle:idcs:extension:jdbcDataProviderParams:ResourceType": {
"table": "IDCS_USER",
"template": "ExtraLargeIdcsTemplate",
"tenantTemplate": "ExtraLargeTenantCustomizationTemplate"
},
"meta": {
"resourceType": "GlobalResourceType",
"location": "https://idcsUrl/admin/v1/GlobalResourceTypes/User",
"created": "2017-06-02T21:01:24.739Z",
"lastModified": "2017-06-02T21:01:24.739Z"
},
"idcsCreatedBy": {
"value": "UnAuthenticated",
"$ref": "https://idcsUrl/admin/v1/GlobalResourceTypes/UnAuthenticated"
},
"idcsLastModifiedBy": {
"value": "UnAuthenticated",
"$ref": "https://idcsUrl/admin/v1/GlobalResourceTypes/UnAuthenticated"
}
}