1. REST API for Oracle Identity Cloud Service
  2. Tasks
  3. Self-Service
  4. My Devices

Search Devices

get

/admin/v1/MyDevices

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 : MyDevice-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 : MyDevice
Type: object
Device Resource.
Show Source
  • additionalAttributes
    SCIM++ Properties:
    • idcsCompositeKey: [key, value]
    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Device additional attributes
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Mobile Authenticator App Version
  • authenticationFactors
    SCIM++ Properties:
    • caseExact: true
    • idcsCompositeKey: [type]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: true
    • returned: default
    • type: complex
    Authentication Factors
  • Minimum Length: 1
    Maximum Length: 256
    Added In: 2009232244

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Authentication method used in device. For FIDO, it will contain SECURITY_KEY/WINDOWS_HELLO etc
  • Minimum Length: 1
    Maximum Length: 4000
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device base public Key
  • 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.
  • Minimum Length: 1
    Maximum Length: 40
    Added In: 19.1.4

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Country code of user's Phone Number
  • 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.
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device hardware name/model
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Unique id sent from device
  • Minimum Length: 1
    Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device friendly display name
  • 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.
  • Added In: 2111040242

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    Attribute added for replication log, it is not used by IDCS, just added as place holder
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.
  • 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.
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Flag that indicates whether the device is enrolled for account recovery
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Device Compliance Status
  • SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    Last Sync time for device
  • Added In: 17.3.6

    SCIM++ Properties:
    • idcsSearchable: false
    • idcsAllowUpdatesInReadOnlyMode: true
    • multiValued: false
    • mutability: readWrite
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The most recent timestamp when the device was successfully validated using one time passcode
  • 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.
  • nonCompliances
    SCIM++ Properties:
    • idcsCompositeKey: [name, value]
    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Device Non Compliances
  • 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.
  • Minimum Length: 1
    Maximum Length: 256
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Mobile Authenticator App Package Id
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    User's Phone Number
  • Minimum Length: 1
    Maximum Length: 40
    Allowed Values: [ "IOS", "ANDROID", "WINDOWS", "CELLULAR" ]
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Device Platform
  • pushNotificationTarget
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Push Notification target. Reference to Device notification related resource
  • Minimum Length: 1
    Maximum Length: 256
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Additional comments/reasons for the change in device status
  • 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.
  • Minimum Length: 1
    Maximum Length: 4000
    Added In: 2111040242

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute added for replication log, it is not used by IDCS, it is actual encrypted TOTP seed for the user
  • Minimum Length: 1
    Maximum Length: 4000
    Added In: 2111040242

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Attribute added for replication log, it is not used by IDCS, the DEK that encrypts the specific seed for that user
  • Minimum Length: 1
    Maximum Length: 15
    Allowed Values: [ "INITIATED", "INPROGRESS", "INACTIVE", "ENROLLED", "LOCKED", "BLOCKED" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device Status
  • 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.
  • thirdPartyFactor
    Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    User's third-party authentication factor details
  • user
    Deprecated Since: 17.3.4

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: complex
    • uniqueness: none
    Device member
Nested Schema : additionalAttributes
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [key, value]
  • idcsSearchable: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Device additional attributes
Show Source
Nested Schema : authenticationFactors
Type: array
SCIM++ Properties:
  • caseExact: true
  • idcsCompositeKey: [type]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: complex
Authentication Factors
Show Source
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 : 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 : nonCompliances
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [name, value]
  • idcsSearchable: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Device Non Compliances
Show Source
Nested Schema : pushNotificationTarget
Type: object
SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Push Notification target. Reference to Device notification related resource
Show Source
  • SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The URI that corresponds to the push notification target resource of this device
  • Minimum Length: 1
    Maximum Length: 40
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: always
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The identifier of the push notification target
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 : 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 : thirdPartyFactor
Type: object
Added In: 19.2.1

SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: false
  • mutability: immutable
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
User's third-party authentication factor details
Show Source
  • Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The URI that corresponds to the third party device resource
  • Minimum Length: 1
    Maximum Length: 80
    Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Type of the third party authentication factor
  • Minimum Length: 1
    Maximum Length: 80
    Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The vendor name of the third party factor
  • Minimum Length: 1
    Maximum Length: 80
    Added In: 19.2.1

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The identifier of third party device
Nested Schema : user
Type: object
Deprecated Since: 17.3.4

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: immutable
  • required: true
  • returned: default
  • type: complex
  • uniqueness: none
Device member
Show Source
  • Deprecated Since: 17.3.4

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The URI that corresponds to the member Resource of this device
  • Deprecated Since: 17.3.4

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    User display name
  • Minimum Length: 1
    Maximum Length: 400
    Added In: 2105091740

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: always
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The OCID of the user
  • Minimum Length: 1
    Maximum Length: 40
    Deprecated Since: 17.3.4

    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: immutable
    • required: true
    • returned: always
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    The identifier of the user
Nested Schema : additionalAttributes
Type: object
Device additional attributes
Show Source
  • Minimum Length: 1
    Maximum Length: 100
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: always
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device Attribute Key Name
  • Minimum Length: 1
    Maximum Length: 100
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device Attribute Value
Nested Schema : authenticationFactors
Type: object
Authentication Factors
Show Source
  • Minimum Length: 1
    Maximum Length: 4000
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Authentication Factor public key issued by client
  • Minimum Length: 1
    Maximum Length: 40
    Allowed Values: [ "INITIATED", "INPROGRESS", "ENROLLED", "LOCKED", "INACTIVE", "BLOCKED" ]
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Authentication Factor Status
  • Minimum Length: 1
    Maximum Length: 40
    Allowed Values: [ "EMAIL", "SMS", "TOTP", "PUSH", "OFFLINETOTP", "VOICE", "PHONE_CALL", "THIRDPARTY", "FIDO_AUTHENTICATOR", "YUBICO_OTP" ]
    SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Authentication Factor Type
Nested Schema : nonCompliances
Type: object
Device Non Compliances
Show Source
  • Minimum Length: 1
    Maximum Length: 40
    Allowed Values: [ "NOTIFY", "BLOCK", "ALLOW", "UNKNOWN" ]
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device Compliance Action
  • Minimum Length: 1
    Maximum Length: 100
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device Compliance name
  • Minimum Length: 1
    Maximum Length: 100
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    • idcsRequiresWriteForAccessFlows: true
    • idcsRequiresImmediateReadAfterWriteForAccessFlows: true
    Device Compliance value
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 a user retrieves a list of devices 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/MyDevices

Example of Response Body

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

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 3,
  "Resources": [
    {
      "status": "INITIATED",
      "displayName": "admin opc's Phone",
      "id": "45c99df6dfc24f93894d0167b45740a8",
      "meta": {
        "created": "2016-11-17T10:51:18.495Z",
        "lastModified": "2016-11-17T10:51:18.495Z",
        "resourceType": "Device",
        "location": "http://host:port/admin/v1/MyDevices/45c99df6dfc24f93894d0167b45740a8"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:Device"
      ],
      "idcsCreatedBy": {
        "value": "idcssso",
        "display": "idcssso",
        "type": "App",
        "$ref": "http://host:port/admin/v1/Apps/idcssso"
      },
      "idcsLastModifiedBy": {
        "value": "idcssso",
        "display": "idcssso",
        "type": "App",
        "$ref": "http://host:port/admin/v1/Apps/idcssso"
      },
      "user": {
        "value": "9fffc58d7d4f4fd69c8d21851686c95e",
        "$ref": "http://host:port/admin/v1/Users/9fffc58d7d4f4fd69c8d21851686c95e"
      },
      "authenticationFactors": [
        {
          "type": "PUSH",
          "status": "INITIATED"
        },
        {
          "type": "TOTP",
          "status": "INITIATED"
        }
      ]
    },
    {
      "status": "ENROLLED",
      "phoneNumber": "919886811150",
      "displayName": "Test device",
      "id": "fff647000543459a9724e02428374b43",
      "meta": {
        "created": "2016-11-17T10:24:28.614Z",
        "lastModified": "2016-11-17T10:24:28.614Z",
        "resourceType": "Device",
        "location": "http://host:port/admin/v1/MyDevices/fff647000543459a9724e02428374b43"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:Device"
      ],
      "idcsCreatedBy": {
        "value": "e590d53525214b9e9c1774d2bf5740a5",
        "display": "admin opc",
        "type": "User",
        "$ref": "http://host:port/admin/v1/Users/e590d53525214b9e9c1774d2bf5740a5"
      },
      "idcsLastModifiedBy": {
        "value": "e590d53525214b9e9c1774d2bf5740a5",
        "display": "admin opc",
        "type": "User",
        "$ref": "http://host:port/admin/v1/Users/e590d53525214b9e9c1774d2bf5740a5"
      },
      "user": {
        "value": "9fffc58d7d4f4fd69c8d21851686c95e",
        "$ref": "http://host:port/admin/v1/Users/9fffc58d7d4f4fd69c8d21851686c95e"
      },
      "authenticationFactors": [
        {
          "type": "SMS",
          "status": "INITIATED"
        }
      ]
    },
    {
      "status": "INPROGRESS",
      "phoneNumber": "919886811150",
      "displayName": "Test device",
      "id": "2b590d0422474385a7edef8298028d81",
      "meta": {
        "created": "2016-11-17T10:26:32.713Z",
        "lastModified": "2016-11-17T10:28:53.506Z",
        "resourceType": "Device",
        "location": "http://host:port/admin/v1/MyDevices/2b590d0422474385a7edef8298028d81"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:Device"
      ],
      "idcsCreatedBy": {
        "value": "e590d53525214b9e9c1774d2bf5740a5",
        "display": "admin opc",
        "type": "User",
        "$ref": "http://host:port/admin/v1/Users/e590d53525214b9e9c1774d2bf5740a5"
      },
      "idcsLastModifiedBy": {
        "value": "e590d53525214b9e9c1774d2bf5740a5",
        "display": "admin opc",
        "type": "User",
        "$ref": "http://host:port/admin/v1/Users/e590d53525214b9e9c1774d2bf5740a5"
      },
      "user": {
        "value": "9fffc58d7d4f4fd69c8d21851686c95e",
        "$ref": "http://host:port/admin/v1/Users/9fffc58d7d4f4fd69c8d21851686c95e"
      },
      "authenticationFactors": [
        {
          "type": "SMS",
          "status": "INITIATED"
        }
      ]
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 50
}
Back to Top