Jump to

• Request
• Response
• Examples

Search Social Identity Providers

get

/admin/v1/SocialIdentityProviders

Request

Query Parameters

• count(optional): number
  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
• filter(optional): string
  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.
• sortBy(optional): string
  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
• sortOrder(optional): string
  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
• startIndex(optional): number
  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

• 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.
• 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 : SocialIdentityProvider-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

• itemsPerPage: integer
  The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.
• Resources: array 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: 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. 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.
• startIndex: integer
  The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.
• totalResults: integer
  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.

{
    "type":"object",
    "description":"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.",
    "required":[
        "schemas",
        "totalResults",
        "Resources",
        "startIndex",
        "itemsPerPage"
    ],
    "properties":{
        "schemas":{
            "type":"array",
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:ListResponse"
            ],
            "items":{
                "type":"string"
            },
            "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. 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."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "Resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SocialIdentityProvider"
            },
            "description":"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."
        },
        "startIndex":{
            "type":"integer",
            "description":"The 1-based index of the first result in the current set of list results.  REQUIRED when partial results returned due to pagination."
        },
        "itemsPerPage":{
            "type":"integer",
            "description":"The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination."
        }
    }
}

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

• Array of: object SocialIdentityProvider
  Social Identity Provider

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SocialIdentityProvider"
    },
    "description":"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."
}

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

• Array of: string

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

Type: object

Social Identity Provider

Show Source

• accessTokenUrl(optional): string
  Maximum Length: 1000

  SCIM++ Properties:
  

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

  Social IDP Access token URL
• accountLinkingEnabled: boolean
  SCIM++ Properties:
  

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

  Whether account linking is enabled
• adminScope(optional): array adminScope
  SCIM++ Properties:
  

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

  Admin scope to request
• authzUrl(optional): string
  Maximum Length: 1000

  SCIM++ Properties:
  

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

  Social IDP Authorization URL
• clientCredentialInPayload(optional): boolean
  Added In: 18.4.2
  
  SCIM++ Properties:
  

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

  Whether the client credential is contained in payload
• clockSkewInSeconds(optional): integer
  SCIM++ Properties:
  

  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: integer
  • uniqueness: none

  Social IDP allowed clock skew time
• 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.
• consumerKey: string
  Maximum Length: 4000

  SCIM++ Properties:
  

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

  Social IDP Client Application Client ID
• consumerSecret: string
  Maximum Length: 4000

  SCIM++ Properties:
  

  • caseExact: true
  • idcsSearchable: false
  • idcsSensitive: encrypt
  • multiValued: false
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none

  Social IDP Client Application Client Secret
• 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.
• description(optional): string
  Maximum Length: 250

  SCIM++ Properties:
  

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

  Social IDP description
• discoveryUrl(optional): string
  Maximum Length: 1000

  Added In: 17.4.6
  
  SCIM++ Properties:
  

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

  Discovery URL
• 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.
• enabled: boolean
  SCIM++ Properties:
  

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

  Whether the IDP is enabled or not
• iconUrl(optional): string
  Maximum Length: 1000

  Added In: 17.4.6
  
  SCIM++ Properties:
  

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

  ICON URL for social idp
• 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.
• idAttribute(optional): string
  Maximum Length: 100

  SCIM++ Properties:
  

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

  Id attribute used for account linking
• 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.
• 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.
• name: string
  Maximum Length: 100

  SCIM++ Properties:
  

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

  Social provider name
• 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.
• profileUrl(optional): string
  Maximum Length: 1000

  SCIM++ Properties:
  

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

  Social IDP User profile URL
• redirectUrl(optional): string
  Maximum Length: 1000

  SCIM++ Properties:
  

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

  redirect URL for social idp
• refreshTokenUrl(optional): string
  Maximum Length: 1000

  Added In: 19.1.4
  
  SCIM++ Properties:
  

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

  Social IDP Refresh token URL
• registrationEnabled: boolean
  SCIM++ Properties:
  

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

  Whether registration is enabled
• 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.
• scope(optional): array scope
  SCIM++ Properties:
  

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

  Scope to request
• serviceProviderName: string
  Maximum Length: 100

  SCIM++ Properties:
  

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

  Service Provider Name
• showOnLogin: boolean
  SCIM++ Properties:
  

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

  Whether show on login
• status(optional): string
  Maximum Length: 100

  Allowed Values: [ "created", "deleted" ]

  Added In: 17.4.6
  
  SCIM++ Properties:
  

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

  Status
• 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.

{
    "type":"object",
    "description":"Social Identity Provider",
    "required":[
        "schemas",
        "idcsCreatedBy",
        "name",
        "enabled",
        "accountLinkingEnabled",
        "registrationEnabled",
        "showOnLogin",
        "consumerKey",
        "consumerSecret",
        "serviceProviderName"
    ],
    "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."
        },
        "name":{
            "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: always</li><li>type: string</li><li>uniqueness: global</li></ul>Social provider name",
            "maxLength":100
        },
        "description":{
            "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: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Social IDP description",
            "maxLength":250
        },
        "enabled":{
            "type":"boolean",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: boolean</li><li>uniqueness: none</li></ul>Whether the IDP is enabled or not"
        },
        "accountLinkingEnabled":{
            "type":"boolean",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: boolean</li><li>uniqueness: none</li></ul>Whether account linking is enabled"
        },
        "registrationEnabled":{
            "type":"boolean",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: boolean</li><li>uniqueness: none</li></ul>Whether registration is enabled"
        },
        "showOnLogin":{
            "type":"boolean",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: boolean</li><li>uniqueness: none</li></ul>Whether show on login"
        },
        "status":{
            "type":"string",
            "enum":[
                "created",
                "deleted"
            ],
            "description":"<b>Added In:</b> 17.4.6<br/><br/><b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: true</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Status",
            "maxLength":100
        },
        "idAttribute":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: immutable</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Id attribute used for account linking",
            "maxLength":100
        },
        "authzUrl":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Social IDP Authorization URL",
            "maxLength":1000
        },
        "accessTokenUrl":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Social IDP Access token URL",
            "maxLength":1000
        },
        "profileUrl":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Social IDP User profile URL",
            "maxLength":1000
        },
        "scope":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Scope to request",
            "maxLength":1000
        },
        "adminScope":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Admin scope to request",
            "maxLength":1000
        },
        "consumerKey":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</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>Social IDP Client Application Client ID",
            "maxLength":4000
        },
        "consumerSecret":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>idcsSensitive: encrypt</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>Social IDP Client Application Client Secret",
            "maxLength":4000
        },
        "serviceProviderName":{
            "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: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Service Provider Name",
            "maxLength":100
        },
        "clockSkewInSeconds":{
            "type":"integer",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: integer</li><li>uniqueness: none</li></ul>Social IDP allowed clock skew time"
        },
        "redirectUrl":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>redirect URL for social idp",
            "maxLength":1000
        },
        "iconUrl":{
            "type":"string",
            "description":"<b>Added In:</b> 17.4.6<br/><br/><b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>ICON URL for social idp",
            "maxLength":1000
        },
        "discoveryUrl":{
            "type":"string",
            "description":"<b>Added In:</b> 17.4.6<br/><br/><b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Discovery URL",
            "maxLength":1000
        },
        "clientCredentialInPayload":{
            "type":"boolean",
            "description":"<b>Added In:</b> 18.4.2<br/><br/><b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: boolean</li><li>uniqueness: none</li></ul>Whether the client credential is contained in payload"
        },
        "refreshTokenUrl":{
            "type":"string",
            "description":"<b>Added In:</b> 19.1.4<br/><br/><b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: false</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Social IDP Refresh token URL",
            "maxLength":1000
        }
    }
}

Nested Schema : adminScope

Type: array

Maximum Length: 1000

SCIM++ Properties:

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

Admin scope to request

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Admin scope to request",
    "maxLength":1000
}

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

Type: array

Maximum Length: 1000

SCIM++ Properties:

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

Scope to request

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: true</li><li>idcsSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: false</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>Scope to request",
    "maxLength":1000
}

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

• 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

Examples

The following example shows how to retrieve a list of existing social identity providers by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.

curl
-X GET
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/SocialIdentityProviders

Example of Response Body

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

{
  "status": 200,
  "response": 
  {
    "schemas": 
    [
      "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "Resources": 
    [
      {
        "registrationEnabled": true,
        "showOnLogin": true,
        "idcsLastModifiedBy": 
        {
          "type": "User",
          "value": "85724acf4f4b4b84abcf02028774a586",
          "display": "admin opc",
          "$ref": "https://tenant-base-url/admin/v1/Users/85724acf4f4b4b84abcf02028774a586"
        },
        "description": "description",
        "idcsCreatedBy": 
        {
          "type": "User",
          "display": "admin opc",
          "value": "85724acf4f4b4b84abcf02028774a586",
          "$ref": "https://tenant-base-url/admin/v1/Users/85724acf4f4b4b84abcf02028774a586"
        },
        "serviceProviderName": "Facebook",
        "enabled": true,
        "accountLinkingEnabled": true,
        "id": "ce89338b8a4447d98e0050f04face11d",
        "meta": 
        {
          "created": "2017-04-27T17:29:46.044Z",
          "lastModified": "2017-04-27T17:30:59.653Z",
          "resourceType": "SocialIdentityProvider",
          "location": "https://tenant-base-url/admin/v1/SocialIdentityProviders/ce89338b8a4447d98e0050f04face11d"
        },
        "name": "test provider 1",
        "schemas": 
        [
          "urn:ietf:params:scim:schemas:oracle:idcs:SocialIdentityProvider"
        ],
        "consumerKey": "clientId123",
        "consumerSecret": "clientSecret12345"
      }
    ],
    "startIndex": 1,
    "itemsPerPage": 50
  }
}

Back to Top