Jump to

• Request
• Response

Get an Trusted Partner Certificate

get

/admin/v1/TrustedPartnerCertificates/{id}

Request

Path Parameters

• id: string
  ID of the resource

Header Parameters

• Authorization: string
  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
• Content-Type: string
  Media Type
• RESOURCE_TYPE_SCHEMA_VERSION(optional): string
  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

Back to Top

Response

Supported Media Types

• application/json
• application/scim+json

200 Response

The request was successful.

Body ()

Root Schema : TrustedPartnerCertificate

Type: object

OAuth Partner Certificate schema

Show Source

• certEndDate(optional): string
  SCIM++ Properties:
  

  • type: dateTime
  • multiValued: false
  • required: false
  • caseExact: true
  • mutability: readWrite
  • returned: default
  • uniqueness: none

  Certificate end date
• certificateAlias: string
  Minimum Length: 1

  Maximum Length: 255

  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: true
  • caseExact: false
  • mutability: readWrite
  • returned: always
  • uniqueness: none
  • idcsSearchable: true

  Certificate alias
• certStartDate(optional): string
  SCIM++ Properties:
  

  • type: dateTime
  • multiValued: false
  • required: false
  • caseExact: true
  • mutability: readWrite
  • returned: default
  • uniqueness: none

  Certificate start date
• compartmentOcid(optional): string
  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.
• deleteInProgress(optional): boolean
  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.
• domainOcid(optional): string
  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.
• externalId(optional): string
  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: false
  • caseExact: false
  • mutability: readWrite
  • returned: default
  • 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 by 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.
• id(optional): string
  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: object idcsCreatedBy
  SCIM++ Properties:
  

  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex

  The User or App who created the Resource
• idcsLastModifiedBy(optional): object idcsLastModifiedBy
  SCIM++ Properties:
  

  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex

  The User or App who modified the Resource
• idcsLastUpgradedInRelease(optional): string
  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(optional): array 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.
• keyStoreId(optional): string
  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: false
  • caseExact: true
  • returned: never
  • uniqueness: none
  • idcsSearchable: true

  Key store ID
• keyStoreName(optional): string
  Minimum Length: 1

  Maximum Length: 255

  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: false
  • caseExact: false
  • returned: always
  • uniqueness: none

  Key store name
• keyStorePassword(optional): string
  Minimum Length: 1

  Maximum Length: 255

  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • idcsSensitive: none
  • required: false
  • caseExact: true
  • returned: never
  • uniqueness: none

  Key store password
• map(optional): string
  Minimum Length: 1

  Maximum Length: 255

  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: false
  • caseExact: false
  • returned: always
  • uniqueness: none

  Map
• meta(optional): object 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.
• ocid(optional): string
  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.
• schemas: array 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.
• sha1Thumbprint(optional): string
  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: false
  • caseExact: true
  • returned: default
  • idcsSearchable: true
  • uniqueness: none

  SHA-1 Thumbprint
• sha256Thumbprint(optional): string
  SCIM++ Properties:
  

  • type: string
  • multiValued: false
  • required: false
  • caseExact: true
  • returned: default
  • idcsSearchable: true
  • uniqueness: none

  SHA-256 Thumbprint
• tags(optional): array 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.
• tenancyOcid(optional): string
  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.
• x509Base64Certificate(optional): object x509Base64Certificate
  SCIM++ Properties:
  

  • caseExact: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: binary
  • uniqueness: none

  Base 64Key data attribute

{
    "type":"object",
    "description":"OAuth Partner Certificate schema",
    "required":[
        "schemas",
        "idcsCreatedBy",
        "certificateAlias"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: always</li><li>type: string</li><li>uniqueness: global</li></ul>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."
        },
        "ocid":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: immutable</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: global</li></ul>Unique OCI identifier for the SCIM Resource.",
            "maxLength":255
        },
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>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."
        },
        "meta":{
            "type":"object",
            "properties":{
                "resourceType":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Name of the resource type of the resource--for example, Users or Groups"
                },
                "created":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: dateTime</li><li>uniqueness: none</li></ul>The DateTime the Resource was added to the Service Provider"
                },
                "lastModified":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: dateTime</li><li>uniqueness: none</li></ul>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."
                },
                "location":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header."
                },
                "version":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The version of the Resource being returned. This value must be the same as the ETag HTTP response header."
                }
            },
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]</li><li>type: complex</li></ul>A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL."
        },
        "idcsCreatedBy":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The ID of the SCIM resource that represents the User or App who created this Resource"
                },
                "$ref":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: reference</li><li>uniqueness: none</li></ul>The URI of the SCIM resource that represents the User or App who created this Resource"
                },
                "type":{
                    "type":"string",
                    "enum":[
                        "User",
                        "App"
                    ],
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The type of resource, User or App, that created this Resource"
                },
                "display":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The displayName of the User or App who created this Resource"
                },
                "ocid":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The OCID of the SCIM resource that represents the User or App who created this Resource"
                }
            },
            "required":[
                "value"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: true</li><li>returned: default</li><li>type: complex</li></ul>The User or App who created the Resource"
        },
        "idcsLastModifiedBy":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The ID of the SCIM resource that represents the User or App who modified this Resource"
                },
                "$ref":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: reference</li><li>uniqueness: none</li></ul>The URI of the SCIM resource that represents the User or App who modified this Resource"
                },
                "type":{
                    "type":"string",
                    "enum":[
                        "User",
                        "App"
                    ],
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The type of resource, User or App, that modified this Resource"
                },
                "display":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The displayName of the User or App who modified this Resource"
                },
                "ocid":{
                    "type":"string",
                    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The OCID of the SCIM resource that represents the User or App who modified this Resource"
                }
            },
            "required":[
                "value"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: complex</li></ul>The User or App who modified the Resource"
        },
        "idcsPreventedOperations":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "replace",
                "update",
                "delete"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readOnly</li><li>required: false</li><li>returned: request</li><li>type: string</li><li>uniqueness: none</li></ul>Each value of this attribute specifies an operation that only an internal client may perform on this particular resource."
        },
        "tags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/tags"
            },
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsCompositeKey: [key, value]</li><li>idcsSearchable: true</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: false</li><li>returned: request</li><li>type: complex</li><li>uniqueness: none</li></ul>A list of tags on this resource."
        },
        "deleteInProgress":{
            "type":"boolean",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: boolean</li><li>uniqueness: none</li></ul>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."
        },
        "idcsLastUpgradedInRelease":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: request</li><li>type: string</li><li>uniqueness: none</li></ul>The release number when the resource was upgraded."
        },
        "domainOcid":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>OCI Domain Id (ocid) in which the resource lives."
        },
        "compartmentOcid":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>OCI Compartment Id (ocid) in which the resource lives."
        },
        "tenancyOcid":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>OCI Tenant Id (ocid) in which the resource lives."
        },
        "externalId":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: false</li><li>caseExact: false</li><li>mutability: readWrite</li><li>returned: default</li><li>uniqueness: none</li></ul>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 by 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."
        },
        "keyStoreName":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: false</li><li>caseExact: false</li><li>returned: always</li><li>uniqueness: none</li></ul>Key store name",
            "minLength":1,
            "maxLength":255
        },
        "map":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: false</li><li>caseExact: false</li><li>returned: always</li><li>uniqueness: none</li></ul>Map",
            "minLength":1,
            "maxLength":255
        },
        "keyStorePassword":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>idcsSensitive: none</li><li>required: false</li><li>caseExact: true</li><li>returned: never</li><li>uniqueness: none</li></ul>Key store password",
            "minLength":1,
            "maxLength":255
        },
        "keyStoreId":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: false</li><li>caseExact: true</li><li>returned: never</li><li>uniqueness: none</li><li>idcsSearchable: true</li></ul>Key store ID"
        },
        "certificateAlias":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: true</li><li>caseExact: false</li><li>mutability: readWrite</li><li>returned: always</li><li>uniqueness: none</li><li>idcsSearchable: true</li></ul>Certificate alias",
            "minLength":1,
            "maxLength":255
        },
        "sha1Thumbprint":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: false</li><li>caseExact: true</li><li>returned: default</li><li>idcsSearchable: true</li><li>uniqueness: none</li></ul>SHA-1 Thumbprint"
        },
        "sha256Thumbprint":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li><li>multiValued: false</li><li>required: false</li><li>caseExact: true</li><li>returned: default</li><li>idcsSearchable: true</li><li>uniqueness: none</li></ul>SHA-256 Thumbprint"
        },
        "certStartDate":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: dateTime</li><li>multiValued: false</li><li>required: false</li><li>caseExact: true</li><li>mutability: readWrite</li><li>returned: default</li><li>uniqueness: none</li></ul>Certificate start date"
        },
        "x509Base64Certificate":{
            "type":"object",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: binary</li><li>uniqueness: none</li></ul>Base 64Key data attribute",
            "maxLength":2048
        },
        "certEndDate":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: dateTime</li><li>multiValued: false</li><li>required: false</li><li>caseExact: true</li><li>mutability: readWrite</li><li>returned: default</li><li>uniqueness: none</li></ul>Certificate end date"
        }
    }
}

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

• $ref(optional): string
  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
• display(optional): string
  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
• ocid(optional): string
  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
• type(optional): string
  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
• value: string
  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

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The ID of the SCIM resource that represents the User or App who created this Resource"
        },
        "$ref":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: reference</li><li>uniqueness: none</li></ul>The URI of the SCIM resource that represents the User or App who created this Resource"
        },
        "type":{
            "type":"string",
            "enum":[
                "User",
                "App"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The type of resource, User or App, that created this Resource"
        },
        "display":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The displayName of the User or App who created this Resource"
        },
        "ocid":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The OCID of the SCIM resource that represents the User or App who created this Resource"
        }
    },
    "required":[
        "value"
    ],
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: true</li><li>returned: default</li><li>type: complex</li></ul>The User or App who created the 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

• $ref(optional): string
  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
• display(optional): string
  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
• ocid(optional): string
  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
• type(optional): string
  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
• value: string
  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

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The ID of the SCIM resource that represents the User or App who modified this Resource"
        },
        "$ref":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: reference</li><li>uniqueness: none</li></ul>The URI of the SCIM resource that represents the User or App who modified this Resource"
        },
        "type":{
            "type":"string",
            "enum":[
                "User",
                "App"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The type of resource, User or App, that modified this Resource"
        },
        "display":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The displayName of the User or App who modified this Resource"
        },
        "ocid":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The OCID of the SCIM resource that represents the User or App who modified this Resource"
        }
    },
    "required":[
        "value"
    ],
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: complex</li></ul>The User or App who modified the 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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "replace",
        "update",
        "delete"
    ],
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readOnly</li><li>required: false</li><li>returned: request</li><li>type: string</li><li>uniqueness: none</li></ul>Each value of this attribute specifies an operation that only an internal client may perform on this particular resource."
}

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

• created(optional): string
  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
• lastModified(optional): string
  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.
• location(optional): string
  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.
• resourceType(optional): string
  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
• version(optional): string
  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.

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Name of the resource type of the resource--for example, Users or Groups"
        },
        "created":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: dateTime</li><li>uniqueness: none</li></ul>The DateTime the Resource was added to the Service Provider"
        },
        "lastModified":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: dateTime</li><li>uniqueness: none</li></ul>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."
        },
        "location":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header."
        },
        "version":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>The version of the Resource being returned. This value must be the same as the ETag HTTP response header."
        }
    },
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readOnly</li><li>required: false</li><li>returned: default</li><li>idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]</li><li>type: complex</li></ul>A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL."
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>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."
}

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

• Array of: object tags
  A list of tags on this resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/tags"
    },
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsCompositeKey: [key, value]</li><li>idcsSearchable: true</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: false</li><li>returned: request</li><li>type: complex</li><li>uniqueness: none</li></ul>A list of tags on this resource."
}

Nested Schema : x509Base64Certificate

Type: object

Maximum Length: 2048

SCIM++ Properties:

• caseExact: true
• multiValued: false
• mutability: readWrite
• required: false
• returned: default
• type: binary
• uniqueness: none

Base 64Key data attribute

Nested Schema : tags

Type: object

A list of tags on this resource.

Show Source

• key: string
  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.
• value: string
  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.

{
    "type":"object",
    "description":"A list of tags on this resource.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Key or name of the tag.",
            "maxLength":256
        },
        "value":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Value of the tag.",
            "maxLength":256
        }
    }
}

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

• detail(optional): string
  A detailed, human readable message. OPTIONAL
• schemas: array schemas
  The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
• status: string
  The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
• urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional): object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
  Extension schema for error messages providing more details with the exception status.
  Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.

{
    "type":"object",
    "description":"The SCIM Protocol uses the HTTP status response status codes defined\n   in <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a> to indicate operation success or failure.\n   Refer the available status codes here : <a href=\"./StatusCodes.html\">Status Codes</a>. <br/>\n   In addition to returning a HTTP response code implementers MUST return\n   the errors in the body of the response in the client requested format\n   containing the error response and, per the HTTP specification, human-\n   readable explanations.",
    "required":[
        "schemas",
        "status"
    ],
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:Error",
                "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
            ],
            "description":"The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code (see <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a>) expressed as a JSON String"
        },
        "detail":{
            "type":"string",
            "description":"A detailed, human readable message. OPTIONAL"
        },
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error":{
            "type":"object",
            "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
            "properties":{
                "messageId":{
                    "type":"string",
                    "description":"Internal error keyword pointing to the exception status message. REQUIRED."
                },
                "additionalData":{
                    "type":"object",
                    "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
                }
            }
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "urn:ietf:params:scim:api:messages:2.0:Error",
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
    ],
    "description":"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."
}

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

• additionalData(optional): object additionalData
  Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
• messageId(optional): string
  Internal error keyword pointing to the exception status message. REQUIRED.

{
    "type":"object",
    "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
    "properties":{
        "messageId":{
            "type":"string",
            "description":"Internal error keyword pointing to the exception status message. REQUIRED."
        },
        "additionalData":{
            "type":"object",
            "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
        }
    }
}

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

• detail(optional): string
  A detailed, human readable message. OPTIONAL
• schemas: array schemas
  The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
• status: string
  The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
• urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional): object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
  Extension schema for error messages providing more details with the exception status.
  Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.

{
    "type":"object",
    "description":"The SCIM Protocol uses the HTTP status response status codes defined\n   in <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a> to indicate operation success or failure.\n   Refer the available status codes here : <a href=\"./StatusCodes.html\">Status Codes</a>. <br/>\n   In addition to returning a HTTP response code implementers MUST return\n   the errors in the body of the response in the client requested format\n   containing the error response and, per the HTTP specification, human-\n   readable explanations.",
    "required":[
        "schemas",
        "status"
    ],
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:Error",
                "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
            ],
            "description":"The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code (see <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a>) expressed as a JSON String"
        },
        "detail":{
            "type":"string",
            "description":"A detailed, human readable message. OPTIONAL"
        },
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error":{
            "type":"object",
            "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
            "properties":{
                "messageId":{
                    "type":"string",
                    "description":"Internal error keyword pointing to the exception status message. REQUIRED."
                },
                "additionalData":{
                    "type":"object",
                    "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
                }
            }
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "urn:ietf:params:scim:api:messages:2.0:Error",
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
    ],
    "description":"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."
}

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

• additionalData(optional): object additionalData
  Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
• messageId(optional): string
  Internal error keyword pointing to the exception status message. REQUIRED.

{
    "type":"object",
    "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
    "properties":{
        "messageId":{
            "type":"string",
            "description":"Internal error keyword pointing to the exception status message. REQUIRED."
        },
        "additionalData":{
            "type":"object",
            "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
        }
    }
}

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

• detail(optional): string
  A detailed, human readable message. OPTIONAL
• schemas: array schemas
  The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
• status: string
  The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
• urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional): object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
  Extension schema for error messages providing more details with the exception status.
  Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.

{
    "type":"object",
    "description":"The SCIM Protocol uses the HTTP status response status codes defined\n   in <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a> to indicate operation success or failure.\n   Refer the available status codes here : <a href=\"./StatusCodes.html\">Status Codes</a>. <br/>\n   In addition to returning a HTTP response code implementers MUST return\n   the errors in the body of the response in the client requested format\n   containing the error response and, per the HTTP specification, human-\n   readable explanations.",
    "required":[
        "schemas",
        "status"
    ],
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:Error",
                "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
            ],
            "description":"The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code (see <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a>) expressed as a JSON String"
        },
        "detail":{
            "type":"string",
            "description":"A detailed, human readable message. OPTIONAL"
        },
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error":{
            "type":"object",
            "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
            "properties":{
                "messageId":{
                    "type":"string",
                    "description":"Internal error keyword pointing to the exception status message. REQUIRED."
                },
                "additionalData":{
                    "type":"object",
                    "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
                }
            }
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "urn:ietf:params:scim:api:messages:2.0:Error",
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
    ],
    "description":"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."
}

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

• additionalData(optional): object additionalData
  Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
• messageId(optional): string
  Internal error keyword pointing to the exception status message. REQUIRED.

{
    "type":"object",
    "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
    "properties":{
        "messageId":{
            "type":"string",
            "description":"Internal error keyword pointing to the exception status message. REQUIRED."
        },
        "additionalData":{
            "type":"object",
            "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
        }
    }
}

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

• detail(optional): string
  A detailed, human readable message. OPTIONAL
• schemas: array schemas
  The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
• status: string
  The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
• urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional): object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
  Extension schema for error messages providing more details with the exception status.
  Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.

{
    "type":"object",
    "description":"The SCIM Protocol uses the HTTP status response status codes defined\n   in <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a> to indicate operation success or failure.\n   Refer the available status codes here : <a href=\"./StatusCodes.html\">Status Codes</a>. <br/>\n   In addition to returning a HTTP response code implementers MUST return\n   the errors in the body of the response in the client requested format\n   containing the error response and, per the HTTP specification, human-\n   readable explanations.",
    "required":[
        "schemas",
        "status"
    ],
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:Error",
                "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
            ],
            "description":"The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code (see <a href=\"https://tools.ietf.org/html/rfc7231#section-6\" target=\"_blank\">Section 6 [RFC7231]</a>) expressed as a JSON String"
        },
        "detail":{
            "type":"string",
            "description":"A detailed, human readable message. OPTIONAL"
        },
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error":{
            "type":"object",
            "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
            "properties":{
                "messageId":{
                    "type":"string",
                    "description":"Internal error keyword pointing to the exception status message. REQUIRED."
                },
                "additionalData":{
                    "type":"object",
                    "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
                }
            }
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "urn:ietf:params:scim:api:messages:2.0:Error",
        "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
    ],
    "description":"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."
}

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

• additionalData(optional): object additionalData
  Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
• messageId(optional): string
  Internal error keyword pointing to the exception status message. REQUIRED.

{
    "type":"object",
    "description":"Extension schema for error messages providing more details with the exception status. <br/>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.",
    "properties":{
        "messageId":{
            "type":"string",
            "description":"Internal error keyword pointing to the exception status message. REQUIRED."
        },
        "additionalData":{
            "type":"object",
            "description":"Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format."
        }
    }
}

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