Get a Managed ObjectClass

get

/admin/v1/ManagedObjectClasses/{id}

Request

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 : ManagedObjectClass
Type: object
ManagedObjectClass schema.
Show Source
  • 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
    SCIM++ Properties:
    • caseExact: false
    • 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 managed object-class
  • fullSyncJobSchedule
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Full synchronization job schedule.
  • 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.
  • Allowed Values: [ "replace", "update", "delete" ]
    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.
  • inboundMappedAction
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    MappedActions specify, when an action is taken (or is detected by the server) on a ManagedObject (e.g., target group or target OU), what happens to any IDCS Resource that is linked to that ManagedObject.
  • inboundMappedAttribute
    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.
  • 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 managed object-class. This attribute maps to \"type\" attribute in \"ObjectClassInfo\" in the Identity Connectors Framework.
  • outboundMappedAction
    Added In: 19.1.4

    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 IDCS 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
  • resourceType
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    ResourceType of the Managed Object
  • 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 managed object-class. Each schema attribute maps to \"AttributeInfo\" in the Identity Connectors Framework (ICF).
  • 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: true
    • returned: default
    • type: complex
    • uniqueness: none
    Operations supported for the managed object-class
  • 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.
Nested Schema : correlationPolicy
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Correlation 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: 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
  • 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
  • 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 : inboundMappedAction
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
MappedActions specify, when an action is taken (or is detected by the server) on a ManagedObject (e.g., target group or target OU), what happens to any IDCS Resource that is linked to that ManagedObject.
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    MappedAction 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
    MappedAction identifier
Nested Schema : inboundMappedAttribute
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsCompositeKey: [value]
  • idcsSearchable: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Inbound Mapped Attribute
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    Mapped Attribute URI
  • Minimum Length: 1
    Maximum Length: 40
    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 : 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: 19.1.4

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 IDCS 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: 19.1.4

    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: 19.1.4

    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 Managed Object
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 managed 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 : 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: [ "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", "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: true
  • returned: default
  • type: complex
  • uniqueness: none
Operations supported for the managed 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 : 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 IDCS.
  • Added In: 18.2.6

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The IDCS 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 IDCS 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 IDCS 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 IDCS 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
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 : 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
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 : 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
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 : 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
  • Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
    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 : 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 managed object classes information 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/json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/ManagedObjectClasses/<ID>

Example of Response Body

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

{
    "container": false,
    "idcsLastModifiedBy": {
        "type": "User",
        "value": "UnAuthenticated",
        "display": "admin opc",
        "$ref": "https://tenant-base-url/admin/v1/Users/UnAuthenticated"
    },
    "idcsCreatedBy": {
        "type": "User",
        "display": "admin opc",
        "value": "9ff5481fc2844878b774554443258e90",
        "$ref": "https://tenant-base-url/admin/v1/Users/9ff5481fc2844878b774554443258e90"
    },
    "id": "47e0a74a86144698b3fadfa913c708e7",
    "meta": {
        "created": "2017-12-11T18:07:59.276Z",
        "lastModified": "2017-12-11T18:07:59.846Z",
        "resourceType": "ManagedObjectClass",
        "location": "https://tenant-base-url/admin/v1/ManagedObjectClasses/47e0a74a86144698b3fadfa913c708e7"
    },
    "name": "__GROUP__",
    "displayName": "null",
    "correlationPolicy": {
        "value": "13e4a7739d5949ab8820719ea1a60734",
        "display": "Correlation Policy for  jctUh for nBKXfY1513015679237",
        "$ref": "https://tenant-base-url/admin/v1/Policies/13e4a7739d5949ab8820719ea1a60734"
    },
    "inboundMappedAction": {
        "value": "de05e9bc92ca41f5bb8ce1ecda9e9cdf",
        "$ref": "https://tenant-base-url/admin/v1/MappedActions/de05e9bc92ca41f5bb8ce1ecda9e9cdf"
    },
    "inboundMappedAttribute": {
        "value": "506fbbf154d74bc28b6a6bb8d926ce38",
        "$ref": "https://tenant-base-url/admin/v1/MappedAttributes/506fbbf154d74bc28b6a6bb8d926ce38"
    },
    "incrementalSyncJobSchedule": {
        "value": "3283c531-116d-4655-9fce-5bf94c49c31a",
        "$ref": "https://tenant-base-url/job/v1/JobSchedules/3283c531-116d-4655-9fce-5bf94c49c31a"
    },
    "resourceType": {
        "value": "ManagedApp47e0a74a86144698b3fadfa913c708e7",
        "$ref": "https://tenant-base-url/admin/v1/ResourceTypes/ManagedApp47e0a74a86144698b3fadfa913c708e7"
    },
    "schema": [
        {
            "idcsName": "GFILE",
            "createable": true,
            "description": "GFILE",
            "returnedByDefault": true,
            "icfType": "byte[]",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "GFILE",
            "updateable": true
        },
        {
            "idcsName": "EMAIL",
            "createable": true,
            "description": "EMAIL",
            "returnedByDefault": true,
            "icfType": "String",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "EMAIL",
            "updateable": true
        },
        {
            "idcsName": "active",
            "createable": true,
            "description": "__ENABLE__",
            "returnedByDefault": true,
            "icfType": "Boolean",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "__ENABLE__",
            "updateable": true
        },
        {
            "idcsName": "ENDDATE",
            "createable": true,
            "description": "ENDDATE",
            "returnedByDefault": true,
            "icfType": "Long",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "ENDDATE",
            "updateable": true
        },
        {
            "idcsName": "CREATEDDATE",
            "createable": true,
            "description": "CREATEDDATE",
            "returnedByDefault": true,
            "icfType": "Long",
            "generated": false,
            "dateField": true,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "CREATEDDATE",
            "updateable": true
        },
        {
            "idcsName": "currentattributes",
            "createable": true,
            "description": "__CURRENT_ATTRIBUTES__",
            "returnedByDefault": true,
            "icfType": "String",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "__CURRENT_ATTRIBUTES__",
            "updateable": true
        },
        {
            "idcsName": "GROUPPERMISSION",
            "createable": true,
            "description": "GROUPPERMISSION",
            "returnedByDefault": true,
            "icfType": "BigDecimal",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "GROUPPERMISSION",
            "updateable": true
        },
        {
            "idcsName": "ALLOWWEBPOSTING",
            "createable": true,
            "description": "ALLOWWEBPOSTING",
            "returnedByDefault": true,
            "icfType": "String",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "ALLOWWEBPOSTING",
            "updateable": true
        },
        {
            "idcsName": "MEMBER_COUNT",
            "createable": true,
            "description": "MEMBER_COUNT",
            "returnedByDefault": true,
            "icfType": "String",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "MEMBER_COUNT",
            "updateable": true
        },
        {
            "idcsName": "name",
            "createable": true,
            "description": "__NAME__",
            "returnedByDefault": true,
            "icfType": "String",
            "generated": false,
            "dateField": false,
            "required": true,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "__NAME__",
            "updateable": true
        },
        {
            "idcsName": "GRPVERSION",
            "createable": true,
            "description": "GRPVERSION",
            "returnedByDefault": true,
            "icfType": "BigDecimal",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "GRPVERSION",
            "updateable": true
        },
        {
            "idcsName": "TOKEN",
            "createable": false,
            "description": "TOKEN",
            "returnedByDefault": true,
            "icfType": "BigDecimal",
            "generated": false,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": false,
            "auditable": false,
            "readable": true,
            "name": "TOKEN",
            "updateable": false
        },
        {
            "idcsName": "uid",
            "createable": false,
            "description": "__UID__",
            "returnedByDefault": true,
            "icfType": "String",
            "generated": true,
            "dateField": false,
            "required": false,
            "multiValued": false,
            "sensitive": false,
            "searchable": true,
            "auditable": false,
            "readable": true,
            "name": "__UID__",
            "updateable": false
        }
    ],
    "situationResponse": {
        "responseForSituationFound": "Accept",
        "responseForSituationConfirmed": "Do-Nothing",
        "responseForSituationUnmatched": "Do-Nothing",
        "responseForSituationMatched": "Assign",
        "responseForSituationLost": "Forget"
    },
    "supportedOperations": [
        {
            "value": "271be5de07ac454a8c1a553ab5415168",
            "display": "create",
            "name": "create",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/271be5de07ac454a8c1a553ab5415168"
        },
        {
            "value": "cf1ee4425b1140f0abd9cc7dbbac55c0",
            "display": "delete",
            "name": "delete",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/cf1ee4425b1140f0abd9cc7dbbac55c0"
        },
        {
            "value": "6f7efa99d4af4c0ea6a3047f313cc08d",
            "display": "search",
            "name": "search",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/6f7efa99d4af4c0ea6a3047f313cc08d"
        },
        {
            "value": "18c88b1241d9444eb21f875bb0365dc2",
            "display": "sync",
            "name": "sync",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/18c88b1241d9444eb21f875bb0365dc2"
        },
        {
            "value": "b94132b863824ec1a431d15fefbf051f",
            "display": "get",
            "name": "get",
            "$ref": "https://tenant-base-url/admin/v1/ManagedAppOperations/b94132b863824ec1a431d15fefbf051f"
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:ManagedObjectClass"
    ]
}
Back to Top