Get a Resource Type

get

/admin/v1/ResourceTypes/{id}

Request

Supported Media Types
Path Parameters
Query Parameters
  • 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.
    Allowed Values: [ "all", "always", "never", "request", "default" ]
  • A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
Header Parameters
  • The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
  • Media Type
  • An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Back to Top

Response

Supported Media Types

200 Response

The request was successful.
Body ()
Root Schema : ResourceType
Type: object
Resource Type
Show Source
Nested Schema : schemaExtensions
Type: array
SCIM++ Properties:
  • type: complex
  • multiValued: true
  • required: false
  • caseExact: false
  • idcsCompositeKey: [schema]
  • mutability: readWrite
  • returned: default
  • uniqueness: none
Resource type schema extensions
Show Source
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:idcsResourceType:ResourceType
Type: object
IDCS Resource Type
Show Source
  • Added In: 17.3.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Added since Release number of the Resource type schema
  • Added In: 19.1.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Boolean indicating whether resources of this ResourceType can be deleted with filter. Default is false
  • Added In: 19.2.1

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Boolean indicating whether resources of this ResourceType can be updated with filter. Default is false
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    True if any Resources can be protected from replace, update, or delete. False by default.
  • Added In: 17.4.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Boolean indicating whether resources of this resource type will be deleted synchronously (false) or asynchronously (true). Default is false.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether any operation on this Resource type is auditable
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Full name of the builder class
  • cache
    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: always
    • type: complex
    • uniqueness: none
    Cache requirements for the Resource type. Cache only provides performance improvements
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether this resource can be exported as CSV format or not
  • csvImportOperationsSupported
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies what csv import operations, if any, are supported, where allowed operations includes \"create\", \"update\", \"replace\" or \"delete\".
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the job collector class for creating job reports. If this attribute is not given in resource type then default job collector class will be used.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Full name of the data provider class
  • Added In: 17.3.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Deprecated since Release number of the Resource type schema
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Display name in UI
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    Earliest supported version of the Resource type schema
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether the Resource type supports etags
  • excludedCommonAttrs
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Each value of this attribute is the name of an attribute defined in Common.json, which needs to be excluded from a resource
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    True if publishing is disabled for api docs. False by default.
  • Added In: 20.1.3

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    external JDBC data source
  • Deprecated Since: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The value should be the name of an external, no operation provider resource type that wraps one or more internal resource types, which should never be exposed externally. Setting this on an internal resource type will ensure that 1) internal resource type names returned in responses (i.e. meta.resourceType = TenantEmailTemplate) will be replaced with the value of externalResourceType before being returned (e.g. meta.resourceType = EmailTemplate), 2) when resources with this value set in their associated ResourceType definition are persisted, the value of externalResourceType will be used in the mapping path value instead of the internal resource type name.
  • featureSpecificSchemaExtensions
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [schemaExtension]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Attribute which specifies whether an extension schema is associated with a set of features or not.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether the Resource needs to be read after create/replace/update operations
  • Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if the resource is replicable for globality.
  • idcsRtsaHideExtensionSchemas
    Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    List of extension schemas that should be processed.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether the Resource type is for internal use only and will not be exposed via REST. False by default
  • Deprecated Since: 19.3.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    Latest supported version of the Resource type schema
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Full nume of the manager class
  • operations
    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [name]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Specifies the list of operations supported by this Resource type
  • resourcesManaged
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Specifies whether the Resource type is per tenant or global (system wide) or both
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Resource attribute name values that represents the sub Resource type names
  • resourceSubTypes
    SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Resource sub types used for authorization within this Resource type
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Resource service name
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether there can only be one instance of this Resource type
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Source Resource type
  • uniqueAttributeNameForDisplay
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Specifies a uniquely identified attribute name for a Resource. For example, the uniquely identified attribute name for user.json is userName. This can only be Simple string attributes. Complex non-multi-valued simple string sub-attribute. Attributes mentioned must always be returned.
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:jdbcDataProviderParams:ResourceType
Type: object
JDBC parameters.
Show Source
  • compositeIndex
    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [columns]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    A complex multi-value attribute that contains attribute names to form composite indexed columns in a table
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: always
    • type: string
    • uniqueness: global
    Table name to store the Resource
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: always
    • type: string
    • uniqueness: global
    Template to be added
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: always
    • type: string
    • uniqueness: global
    Template to be added
Nested Schema : schemaExtensions
Type: object
Resource type schema extensions
Show Source
  • SCIM++ Properties:
    • type: boolean
    • multiValued: false
    • required: true
    • caseExact: false
    • mutability: readWrite
    • returned: default
    • uniqueness: none
    Indicates whether the extension is required for the Resource type
  • SCIM++ Properties:
    • type: string
    • multiValued: false
    • required: true
    • caseExact: false
    • mutability: readWrite
    • returned: default
    • uniqueness: none
    The URI of an extended schema
Nested Schema : cache
Type: object
SCIM++ Properties:
  • caseExact: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: always
  • type: complex
  • uniqueness: none
Cache requirements for the Resource type. Cache only provides performance improvements
Show Source
  • attributesAffectingCacheability
    Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A comma-separated list of attribute names which can change the cacheability of the resource. These attributes can not be modified to make sure that the cacheability of a resource is never changed once its created.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Set this attribute to True if Resources of this type need to be cached. If this Resource type is declared cacheable, declare all other Resource types that expose the same physical resource as cacheable with a suitable sourceResourceType.
  • compositeKeys
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    A comma-separated list of attribute names with which cache would save the object in the cache in addition to the ID--for example, it should be a secondary key. If only one attribute is specified, it should have a uniqueness level of global. This attribute can only be a String type and only come from the schema declared for this Resource type, not from schemasExtensions. For Example: [\"name\", \"lastName, employeeId\"]
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The DataHandler to be used to transform data being put into cache or pulled out of cache
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Set this attribute to True if Resources of this type need to be cached with an appended key that indicates the logged-in user's locale. For example, when localizeCacheKey is set to True, the Resource is cached with a countries-en-US key.
  • Allowed Values: [ "lasting", "transient", "tenant-near" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Set to Lasting if Resources of this type seldom change and can be accessed for every REST request--for example, Tenant and Schema Definitions. Use Transient if Resources of this type match any of the following conditions: a)Can change often b)Accessed for only a few REST requests c)Can have a large number of Resources of this type (or the size is not limited or known before hand). Most Resources such as User, Group, and so on would fit this type.
Nested Schema : csvImportOperationsSupported
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Specifies what csv import operations, if any, are supported, where allowed operations includes \"create\", \"update\", \"replace\" or \"delete\".
Allowed Values: [ "create", "update", "replace", "delete" ]
Show Source
Nested Schema : excludedCommonAttrs
Type: array
Added In: 17.4.6

SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Each value of this attribute is the name of an attribute defined in Common.json, which needs to be excluded from a resource
Show Source
Nested Schema : featureSpecificSchemaExtensions
Type: array
Deprecated Since: 19.1.6

SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [schemaExtension]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Attribute which specifies whether an extension schema is associated with a set of features or not.
Show Source
  • featureSpecificSchemaExtensions
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [schemaExtension]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Attribute which specifies whether an extension schema is associated with a set of features or not.
Nested Schema : idcsRtsaHideExtensionSchemas
Type: array
Added In: 19.1.4

SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
List of extension schemas that should be processed.
Show Source
Nested Schema : operations
Type: array
SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [name]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Specifies the list of operations supported by this Resource type
Show Source
  • operations
    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [name]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Specifies the list of operations supported by this Resource type
Nested Schema : resourcesManaged
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
Specifies whether the Resource type is per tenant or global (system wide) or both
Allowed Values: [ "tenant", "global" ]
Show Source
Nested Schema : resourceSubTypes
Type: array
SCIM++ Properties:
  • caseExact: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Resource sub types used for authorization within this Resource type
Show Source
Nested Schema : uniqueAttributeNameForDisplay
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
Specifies a uniquely identified attribute name for a Resource. For example, the uniquely identified attribute name for user.json is userName. This can only be Simple string attributes. Complex non-multi-valued simple string sub-attribute. Attributes mentioned must always be returned.
Show Source
Nested Schema : attributesAffectingCacheability
Type: array
Added In: 20.1.3

SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
A comma-separated list of attribute names which can change the cacheability of the resource. These attributes can not be modified to make sure that the cacheability of a resource is never changed once its created.
Show Source
Nested Schema : compositeKeys
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
A comma-separated list of attribute names with which cache would save the object in the cache in addition to the ID--for example, it should be a secondary key. If only one attribute is specified, it should have a uniqueness level of global. This attribute can only be a String type and only come from the schema declared for this Resource type, not from schemasExtensions. For Example: [\"name\", \"lastName, employeeId\"]
Show Source
Nested Schema : featureSpecificSchemaExtensions
Type: object
Deprecated Since: 19.1.6

SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [schemaExtension]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Attribute which specifies whether an extension schema is associated with a set of features or not.
Show Source
  • Allowed Values: [ "optionalPii", "mfa", "social", "schemaCustomization" ]
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The list of features the extension schema is associated with.
  • Deprecated Since: 19.1.6

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The name of the extension schema.
Nested Schema : operations
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [name]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Specifies the list of operations supported by this Resource type
Show Source
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    True if operation is truly a read operation using POST/PUT with NoOp provider, e.g. POST /PasswordAuthenticator. False by default.
  • Allowed Values: [ "success", "failure" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the operation results are targeted for analysis
  • Allowed Values: [ "success", "failure" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the operation results are targeted for audit
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether the cache put operation should be completed after the post callback
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether a composite event for this operation needs to be published to the composite event handler (True), or individual events are published one by one to targeted handlers (False). False is the default.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Operation description
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies the eventId for this operation, if applicable. If not specified, the eventId is auto-generated from the ResourceTypeDef's name, operation, and so on.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    True if publishing is disabled for api docs. False by default.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies list of feature names for license toggle
  • 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
    Specifies write type for replication. GET/SEARCH calls are direct by default, CRUD calls are redirect by default.Resources can use this attribute to define localwrite/direct/writeMasterOnly or override default behaviour.
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether this operation can be called via REST (True) or only via Java APIs (False). True is the default.
  • Allowed Values: [ "success", "failure" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the operation results are targeted for metrics processing
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Health Metrics display name
  • 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
    Operation name
  • Allowed Values: [ "success", "failure" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the operation results are targeted for notification
  • Allowed Values: [ "success", "failure" ]
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Specifies if the operation results are targeted for subscribers
Nested Schema : compositeIndex
Type: array
SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [columns]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
A complex multi-value attribute that contains attribute names to form composite indexed columns in a table
Show Source
  • compositeIndex
    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [columns]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    A complex multi-value attribute that contains attribute names to form composite indexed columns in a table
Nested Schema : compositeIndex
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [columns]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
A complex multi-value attribute that contains attribute names to form composite indexed columns in a table
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Attribute name to form composite indexed columns
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Create unique index if true, otherwise create index

400 Response

Bad or invalid request
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

401 Response

The supplied credentials, if any, are not sufficient to access the resource.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

404 Response

The requested resource was not found.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

500 Response

We couldn't return the representation due to an internal server error.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
Back to Top

Examples

The following example shows how to 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 structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.
curl
-X 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"
    }
}
Back to Top