1. REST API for Oracle Identity Cloud Service
  2. Tasks
  3. Apps
  4. Account Object Classes

Search Account ObjectClasses

get

/admin/v1/AccountObjectClasses

Request

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.
  • Maximum Value: 1000
    OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4).
    Default Value: 50
  • OPTIONAL. The filter string that is used to request a subset of resources. See the Using the Filter Query Parameter section of the Query Parameters page in Get Started. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.
  • OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3).
    Default Value: id
  • OPTIONAL. A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See the Sorting section of the SCIM specification for more information (Section 3.4.2.3).
    Default Value: ascending
  • OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on.
    Default Value: 1
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.
  • 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 : AccountObjectClass-ListResponse
Type: object
The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI.
Show Source
  • The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.
  • Resources
    A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.
  • The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED.
Nested Schema : Resources
Type: array
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
Show Source
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ]
Show Source
Nested Schema : AccountObjectClass
Type: object
AccountObjectClass schema.
Show Source
  • attributeValueGenerationPolicy
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Attribute value generation policy
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCI Compartment Id (ocid) in which the resource lives.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this object-class is a container in the target application. This attribute maps to \"isContainer\" attribute in \"ObjectClassInfo\" in the Identity Connectors Framework.
  • correlationPolicy
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Correlation policy
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Display name of the account object-class
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCI Domain Id (ocid) in which the resource lives.
  • fullSyncJobSchedule
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Full synchronization job schedule.
  • Maximum Length: 40
    Allowed Values: [ "SSHA256", "SSHA384", "SSHA512", "PBKDF2-HMAC-SHA1", "PBKDF2-HMAC-SHA256", "PBKDF2-HMAC-SHA384", "PBKDF2-HMAC-SHA512", "SC" ]
    Added In: 2206081615

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Hashing algorithm for this App
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: always
    • type: string
    • uniqueness: global
    Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
  • idcsCreatedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    The User or App who created the Resource
  • idcsLastModifiedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    The User or App who modified the Resource
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    The release number when the resource was upgraded.
  • idcsPreventedOperations
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
  • Allowed Values: [ "Primary email address", "Work email address", "User Name" ]
    Deprecated Since: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    User attribute that will be used for owner correlation in synchronization
  • inboundMappedAction
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Inbound MappedActions specify, when an action is taken (or is detected by the server) on a ManagedObject (e.g., target account or target group or target OU), what happens to any Oracle Identity Cloud Service Resource that is linked to that ManagedObject.
  • inboundMappedAttribute
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [value]
    • idcsSearchable: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Inbound Mapped Attribute
  • incrementalSyncJobSchedule
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Incremental synchronization job schedule.
  • Added In: 2206081615

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, hashed password is supported for this App
  • lifeCycleEvents
    Deprecated Since: 17.4.6

    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [name]
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Configuration for lifecycle events
  • meta
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
    • type: complex
    A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Name of the account object-class. This attribute maps to \"type\" attribute in \"ObjectClassInfo\" in the Identity Connectors Framework.
  • Maximum Length: 255
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: global
    Unique OCI identifier for the SCIM Resource.
  • outboundMappedAction
    Added In: 18.4.2

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Outbound MappedActions specify, when an action is taken on a Oracle Identity Cloud Service Resource that is linked to a ManagedObject (e.g., target account or target group or target OU), what happens to that ManagedObject.
  • outboundMappedAttribute
    Added In: 19.1.4

    SCIM++ Properties:
    • idcsCompositeKey: [value]
    • idcsSearchable: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Outbound Mapped Attribute
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, the current account password is needed to reset the account password in the target. This attribute maps to \"CURRENT_PASSWORD\" in \"OperationAttributesInfo\" in the Identity Connectors Framework (ICF).
  • resourceType
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    ResourceType of the Account
  • schema
    SCIM++ Properties:
    • caseExact: false
    • idcsCompositeKey: [name]
    • idcsSearchable: false
    • multiValued: true
    • mutability: immutable
    • required: true
    • returned: default
    • type: complex
    • uniqueness: none
    Schema attributes of the account object-class. Each schema attribute maps to \"AttributeInfo\" in the Identity Connectors Framework (ICF).
  • schemas
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
  • situationResponse
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Situation response configuration for sync
  • supportedOperations
    SCIM++ Properties:
    • idcsCompositeKey: [value]
    • idcsSearchable: false
    • multiValued: true
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Operations supported for the account object-class
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The maximum number of objects created during a sync. If the number of objects being created exceeds the maximum number allowed, the sync job aborts. The maximum number of objects that can be created is an approximate maximum limit, not a precise limit due to the parallel processing of synced objects.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The maximum number of recorded objects deleted during a sync. If the number of recorded objects being deleted exceeds the maximum number allowed (including the deletion detection), the sync job aborts. The maximum number of recorded objects that can be deleted is an approximate maximum limit, not a precise limit due to the parallel processing of synced objects.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The maximum number of allowed errors during a sync. If the number of errors exceeds the maximum number allowed, the sync job aborts. The maximum number of errors is an approximate maximum limit, not a precise limit due to the parallel processing of synced objects.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Synchronization token from the most recent synchronization. This attribute maps to \"SyncToken\" in the Identity Connectors Framework (ICF).
  • tags
    SCIM++ Properties:
    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    A list of tags on this resource.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCI Tenant Id (ocid) in which the resource lives.
  • Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, then current attribute values are needed to make changes to the target resource. This attribute maps to \"CURRENT_ATTRIBUTES\" in \"OperationAttributes\" in ICF.
Nested Schema : attributeValueGenerationPolicy
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Attribute value generation policy
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Policy URI
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Policy display name
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Policy identifier
Nested Schema : correlationPolicy
Type: object
Added In: 17.4.6

SCIM++ Properties:
  • caseExact: true
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Correlation policy
Show Source
  • Added In: 17.4.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Policy URI
  • Added In: 17.4.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Policy display name
  • Minimum Length: 1
    Maximum Length: 40
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Policy identifier
Nested Schema : fullSyncJobSchedule
Type: object
SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Full synchronization job schedule.
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    JobSchedule URI
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    JobSchedule Identifier
Nested Schema : idcsCreatedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex
The User or App who created the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    The OCID of the SCIM resource that represents the User or App who created this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who created this Resource
Nested Schema : idcsLastModifiedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
The User or App who modified the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    The OCID of the SCIM resource that represents the User or App who modified this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who modified this Resource
Nested Schema : idcsPreventedOperations
Type: array
SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Allowed Values: [ "replace", "update", "delete" ]
Show Source
Nested Schema : inboundMappedAction
Type: object
Added In: 17.4.6

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Inbound MappedActions specify, when an action is taken (or is detected by the server) on a ManagedObject (e.g., target account or target group or target OU), what happens to any Oracle Identity Cloud Service Resource that is linked to that ManagedObject.
Show Source
  • Added In: 17.4.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    MappedAction URI
  • Minimum Length: 1
    Maximum Length: 40
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    MappedAction identifier
Nested Schema : inboundMappedAttribute
Type: object
Added In: 17.4.6

SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [value]
  • idcsSearchable: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Inbound Mapped Attribute
Show Source
  • Added In: 17.4.6

    SCIM++ Properties:
    • idcsSearchable: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Mapped Attribute URI
  • Minimum Length: 1
    Maximum Length: 40
    Added In: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Mapped Attribute identifier
Nested Schema : incrementalSyncJobSchedule
Type: object
SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Incremental synchronization job schedule.
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    JobSchedule URI
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    JobSchedule Identifier
Nested Schema : lifeCycleEvents
Type: array
Deprecated Since: 17.4.6

SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [name]
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Configuration for lifecycle events
Show Source
Nested Schema : meta
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
  • type: complex
A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The DateTime the Resource was added to the Service Provider
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Name of the resource type of the resource--for example, Users or Groups
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.
Nested Schema : outboundMappedAction
Type: object
Added In: 18.4.2

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Outbound MappedActions specify, when an action is taken on a Oracle Identity Cloud Service Resource that is linked to a ManagedObject (e.g., target account or target group or target OU), what happens to that ManagedObject.
Show Source
  • Added In: 18.4.2

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    MappedAction URI
  • Minimum Length: 1
    Maximum Length: 40
    Added In: 18.4.2

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    MappedAction identifier
Nested Schema : outboundMappedAttribute
Type: object
Added In: 19.1.4

SCIM++ Properties:
  • idcsCompositeKey: [value]
  • idcsSearchable: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Outbound Mapped Attribute
Show Source
  • Added In: 19.1.4

    SCIM++ Properties:
    • idcsSearchable: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Mapped Attribute URI
  • Minimum Length: 1
    Maximum Length: 40
    Added In: 19.1.4

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Mapped Attribute identifier
Nested Schema : resourceType
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: immutable
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
ResourceType of the Account
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    ResoureceType URI
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ResourceType display name
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: global
    ResourceType Identifier
Nested Schema : schema
Type: array
SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [name]
  • idcsSearchable: false
  • multiValued: true
  • mutability: immutable
  • required: true
  • returned: default
  • type: complex
  • uniqueness: none
Schema attributes of the account object-class. Each schema attribute maps to \"AttributeInfo\" in the Identity Connectors Framework (ICF).
Show Source
  • schema
    Schema attributes of the account object-class. Each schema attribute maps to "AttributeInfo" in ICF.
Nested Schema : schemas
Type: array
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Show Source
Nested Schema : situationResponse
Type: object
SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Situation response configuration for sync
Show Source
  • Allowed Values: [ "Do-Nothing" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Response for situation confirmed
  • Allowed Values: [ "Do-Nothing" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Response for situation disputed
  • Allowed Values: [ "Accept", "Do-Nothing" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Response for situation found
  • Allowed Values: [ "Forget" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Response for situation lost
  • Allowed Values: [ "Assign", "Hold", "Do-Nothing" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Response for situation matched
  • Allowed Values: [ "Do-Nothing" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Response for situation unmatched
Nested Schema : supportedOperations
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [value]
  • idcsSearchable: false
  • multiValued: true
  • mutability: immutable
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Operations supported for the account object-class
Show Source
Nested Schema : tags
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [key, value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none
A list of tags on this resource.
Show Source
Nested Schema : lifeCycleEvents
Type: object
Configuration for life-cycle events
Show Source
  • Allowed Values: [ "delete_account_in_managedapp", "deactivate_account_in_managedapp", "activate_account_in_managedapp", "propagate_to_managedapp" ]
    Deprecated Since: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Action for the life-cycle event.
  • Allowed Values: [ "user_delete", "user_deactivate", "user_activate", "user_password_reset", "app_activate", "app_deactivate", "app_delete" ]
    Deprecated Since: 17.4.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Name of the life-cycle event
Nested Schema : schema
Type: object
Schema attributes of the account object-class. Each schema attribute maps to "AttributeInfo" in ICF.
Show Source
  • Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The name of the attribute to be used to display the AllowedValues in the UI. This is a mandatory attribute when defining dynamic AllowedValues. For static allowed values we implicitly display the \"attrValues\" in the UI. For dynamic allowed values, this attribute can refer to an idcsName from the \"ManagedObjectClassTemplate\" schema.
  • Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The source of the value for the specific AllowedValue. In case of static allowed values, the attribute holds the value of \"attrName\". For dynamic allowed values, this attribute hold the name of the \"ManagedObjectClassTemplate\" (__GROUP__ for instance).
  • Allowed Values: [ "static", "dynamic" ]
    Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Type of the allowed value.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is auditable.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is createable. This attribute maps to \"isCreateable\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If icfType is Long, this attribute can be set to true to identify date fields.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Description of the schema attribute.
  • Added In: 18.2.6

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The display name of this attribute
  • Added In: 17.4.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is generated. This attribute maps to \"isGenerated\" attribute in \"AttributeInfo\" in ICF.
  • Allowed Values: [ "Long", "String", "Character", "Double", "Float", "Integer", "Boolean", "BigDecimal", "byte[]", "BigInteger", "GuardedByteArray", "GuardedString" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    ICF data type of the schema attribute. This attribute maps to \"type\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    SCIM compliant name of the schema attribute in Oracle Identity Cloud Service.
  • Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The Oracle Identity Cloud Service UI will use this metadata to sequence the attributes displayed on the Account Form.
  • Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The Oracle Identity Cloud Service UI will use this metadata to validate the attribute values using regular expressions.
  • Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    The Oracle Identity Cloud Service UI will use this metadata to decide whether the attribute must be displayed on the Account Form.
  • Allowed Values: [ "inputtext", "checkbox", "textarea", "combobox" ]
    Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The Oracle Identity Cloud Service UI will use this metadata to render a widget for this attribute on the Account Form.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is multi-valued. This attribute maps to \"isMultiValued\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Name of the schema attribute in the account object-class. This attribute maps to \"name\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is readable. This attribute maps to \"isReadable\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is required for create operation in the target. This attribute maps to \"isRequired\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is returned by default. This attribute maps to \"isReturnedByDefault\" attribute in \"AttributeInfo\" in ICF.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is searchable.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is a sensitive attribute.
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    If true, this schema attribute is updateable. This attribute maps to \"isUpdateable\" attribute in \"AttributeInfo\" in ICF.
Nested Schema : supportedOperations
Type: object
Operations supported for the account object-class.
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    ManagedAppOperationTemplate URI
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ManagedAppOperationTemplate display name
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    ManagedAppOperationTemplate name
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    ManagedAppOperationTemplate identifier
Nested Schema : tags
Type: object
A list of tags on this resource.
Show Source
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Key or name of the tag.
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Value of the tag.

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 could not be 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 list of existing account object classes for the tenant 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/AccountObjectClasses

Example of Response Body

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

{
  "status": 200,
  "response": {
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "Resources": [
      {
        "container": false,
        "idcsLastModifiedBy": {
          "type": "User",
          "value": "4e153d51a1af478b9dd31c3dcfa81b22",
          "display": "admin opc",
          "$ref": "https://tenant-base-url/admin/v1/Users/4e153d51a1af478b9dd31c3dcfa81b22"
        },
        "idcsCreatedBy": {
          "type": "User",
          "display": "admin opc",
          "value": "4e153d51a1af478b9dd31c3dcfa81b22",
          "$ref": "https://tenant-base-url/admin/v1/Users/4e153d51a1af478b9dd31c3dcfa81b22"
        },
        "id": "a9d5e31b8eb546649207f1f360b3cb46",
        "syncDeleteThreshold": 10,
        "passwordResetRequiresCurrentPassword": false,
        "meta": {
          "created": "2017-04-26T22:55:26.081Z",
          "lastModified": "2017-04-27T19:27:37.211Z",
          "resourceType": "AccountObjectClass",
          "location": "https://tenant-base-url/admin/v1/AccountObjectClasses/a9d5e31b8eb546649207f1f360b3cb46"
        },
        "syncCreateThreshold": 10,
        "name": "__ACCOUNT__",
        "displayName": "AccountObjectClassTemplate for Google",
        "idcsUserCorrelationAttribute": "Primary email address",
        "attributeValueGenerationPolicy": {
          "value": "98dca3fc23374caaa13a867f3281f656",
          "display": "AVG PolicyTemplate for Google for Google Suite1493247325761",
          "$ref": "https://tenant-base-url/admin/v1/Policies/98dca3fc23374caaa13a867f3281f656"
        },
        "fullSyncJobSchedule": {
          "value": "e1f507e1-14c6-4076-8bf4-887a58182313",
          "$ref": "https://tenant-base-url/job/v1/JobSchedules/e1f507e1-14c6-4076-8bf4-887a58182313"
        },
        "resourceType": {
          "value": "ManagedAppa9d5e31b8eb546649207f1f360b3cb46",
          "$ref": "https://tenant-base-url/admin/v1/ResourceTypes/ManagedAppa9d5e31b8eb546649207f1f360b3cb46"
        },
        "schema": [
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "isMailboxSetup",
            "updateable": true,
            "description": "isMailboxSetup",
            "returnedByDefault": true,
            "idcsName": "isMailboxSetup",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "thumbnailPhotoUrl",
            "updateable": true,
            "description": "thumbnailPhotoUrl",
            "returnedByDefault": true,
            "idcsName": "thumbnailPhotoUrl",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "customerId",
            "updateable": true,
            "description": "customerId",
            "returnedByDefault": true,
            "idcsName": "customerId",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": true,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "__NAME__",
            "updateable": true,
            "description": "__NAME__",
            "returnedByDefault": true,
            "idcsName": "name",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "__UID__",
            "updateable": false,
            "description": "__UID__",
            "returnedByDefault": true,
            "idcsName": "uid",
            "createable": false
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": true,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "primaryEmail",
            "updateable": true,
            "description": "primaryEmail",
            "returnedByDefault": true,
            "idcsName": "primaryEmail",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": true,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "givenName",
            "updateable": true,
            "description": "givenName",
            "returnedByDefault": true,
            "idcsName": "givenName",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "isDelegatedAdmin",
            "updateable": true,
            "description": "isDelegatedAdmin",
            "returnedByDefault": true,
            "idcsName": "isDelegatedAdmin",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "GuardedString",
            "multiValued": false,
            "required": true,
            "searchable": false,
            "sensitive": true,
            "readable": false,
            "auditable": false,
            "name": "__PASSWORD__",
            "updateable": true,
            "description": "__PASSWORD__",
            "returnedByDefault": false,
            "idcsName": "password",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "agreedToTerms",
            "updateable": true,
            "description": "agreedToTerms",
            "returnedByDefault": true,
            "idcsName": "agreedToTerms",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "hashFunction",
            "updateable": true,
            "description": "hashFunction",
            "returnedByDefault": true,
            "idcsName": "hashFunction",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "ipWhitelisted",
            "updateable": true,
            "description": "ipWhitelisted",
            "returnedByDefault": true,
            "idcsName": "ipWhitelisted",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "__ENABLE__",
            "updateable": true,
            "description": "__ENABLE__",
            "returnedByDefault": true,
            "idcsName": "active",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "changePasswordAtNextLogin",
            "updateable": true,
            "description": "changePasswordAtNextLogin",
            "returnedByDefault": true,
            "idcsName": "changePasswordAtNextLogin",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "suspended",
            "updateable": true,
            "description": "suspended",
            "returnedByDefault": true,
            "idcsName": "suspended",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "isAdmin",
            "updateable": true,
            "description": "isAdmin",
            "returnedByDefault": true,
            "idcsName": "isAdmin",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "orgunitpath",
            "updateable": true,
            "description": "orgunitpath",
            "returnedByDefault": true,
            "idcsName": "orgunitpath",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "Boolean",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "includeInGlobalAddressList",
            "updateable": true,
            "description": "includeInGlobalAddressList",
            "returnedByDefault": true,
            "idcsName": "includeInGlobalAddressList",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": true,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "familyName",
            "updateable": true,
            "description": "familyName",
            "returnedByDefault": true,
            "idcsName": "familyName",
            "createable": true
          },
          {
            "dateField": false,
            "icfType": "String",
            "multiValued": false,
            "required": false,
            "searchable": true,
            "sensitive": false,
            "readable": true,
            "auditable": false,
            "name": "suspensionReason",
            "updateable": true,
            "description": "suspensionReason",
            "returnedByDefault": true,
            "idcsName": "suspensionReason",
            "createable": true
          }
        ],
        "situationResponse": {
          "responseForSituationMatched": "Hold",
          "responseForSituationDisputed": "Do-Nothing",
          "responseForSituationLost": "Forget",
          "responseForSituationConfirmed": "Do-Nothing",
          "responseForSituationUnmatched": "Do-Nothing",
          "responseForSituationFound": "Accept"
        },
        "supportedOperations": [
          {
            "value": "0aa7465445ab4090b139364868a7bf69",
            "display": "activate",
            "name": "activate",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/0aa7465445ab4090b139364868a7bf69"
          },
          {
            "value": "54c3512b9f38407784d83690735af56c",
            "display": "deactivate",
            "name": "deactivate",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/54c3512b9f38407784d83690735af56c"
          },
          {
            "value": "de5e7a5197d245edaa4470471409491e",
            "display": "create",
            "name": "create",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/de5e7a5197d245edaa4470471409491e"
          },
          {
            "value": "8701d47a2fbb4bbb95dde7a5b0cb9bc0",
            "display": "delete",
            "name": "delete",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/8701d47a2fbb4bbb95dde7a5b0cb9bc0"
          },
          {
            "value": "b89a895a3c6b452bb1ca1e99e0abf56b",
            "display": "search",
            "name": "search",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/b89a895a3c6b452bb1ca1e99e0abf56b"
          },
          {
            "value": "f2dd677e43ca440da0de870d8f36851a",
            "display": "password_reset",
            "name": "password_reset",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/f2dd677e43ca440da0de870d8f36851a"
          }
        ],
        "schemas": [
          "urn:ietf:params:scim:schemas:oracle:idcs:AccountObjectClass"
        ]
      }
    ],
    "startIndex": 1,
    "itemsPerPage": 50
  }
}
Back to Top