1. REST API for Oracle Identity Cloud Service
  2. Tasks
  3. Common
  4. Settings

Search Settings Using POST

post

/admin/v1/Settings/.search

Request

Supported Media Types
Header Parameters
  • The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
  • Media Type
  • An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Body ()
Root Schema : Settings-SearchRequest
Type: object
Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the /.search path extension. The inclusion of /.search on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in /.search). The body of the POST request MAY include any of the parameters.
Show Source
  • attributes
    A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.
  • attributeSets
    A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.
Nested Schema : attributes
Type: array
A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.
Show Source
Nested Schema : attributeSets
Type: array
A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.
Allowed Values: [ "all", "always", "never", "request", "default" ]
Show Source
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:SearchRequest" ]
Show Source
Back to Top

Response

Supported Media Types

200 Response

The request was successful.
Body ()
Root Schema : Settings-ListResponse
Type: object
The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI.
Show Source
  • The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.
  • Resources
    A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.
  • The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED.
Nested Schema : Resources
Type: array
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
Show Source
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ]
Show Source
Nested Schema : Settings
Type: object
Settings schema
Show Source
  • Added In: 18.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates whether all the Apps in this customer tenancy should trust each other. A value of true overrides the 'defaultTrustScope' attribute here in Settings, as well as any App-specific 'trustScope' attribute, to force in effect 'trustScope=Account' for every App in this customer tenancy.
  • allowedDomains
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    One or more email domains allowed in a user's email field. If unassigned, any domain is allowed.
  • allowedForgotPasswordFlowReturnUrls
    Added In: 19.3.3

    SCIM++ Properties:
    • type: string
    • multiValued: true
    • required: false
    • mutability: readWrite
    • returned: default
    • uniqueness: none
    • caseExact: false
    If specified, indicates the set of Urls which can be returned to after successful forgot password flow
  • allowedNotificationRedirectUrls
    Added In: 2009041201

    SCIM++ Properties:
    • type: string
    • multiValued: true
    • required: false
    • mutability: readWrite
    • returned: default
    • uniqueness: none
    • caseExact: false
    If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of \"notificationRedirectUrl\" in the POST .../admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow.
  • Allowed Values: [ "30", "60", "90" ]
    Added In: 19.2.1

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    Audit Event retention period. If set, overrides default of 30 days after which Audit Events will be purged
  • certificateValidation
    Added In: 2010242156

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Certificate Validation Config
  • Deprecated Since: 2011192329

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The attribute to store the cloud account name
  • cloudGateCorsSettings
    Added In: 2011192329

    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    A complex attribute that specifies the Cloud Gate cross origin resource sharing settings.
  • Added In: 2012271618

    SCIM++ Properties:
    • type: string
    • multiValued: false
    • required: false
    • mutability: readWrite
    • returned: default
    • uniqueness: none
    • caseExact: false
    If specified, indicates the custom SIM Migrator Url which can be used while SIM to Oracle Identity Cloud Service CloudAccount Migration.
  • Added In: 2012271618

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    CloudAccountMigration: Enable Custom SIM Migrator Url.
  • companyNames
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Name of the company in different locales
  • 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.
  • contactEmails
    SCIM++ Properties:
    • caseExact: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Contact emails used to notify tenants. Can be one or more user or group alias emails.
  • Allowed Values: [ "readOnly", "readWrite", "none" ]
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access. A value of 'none' means CSR cannot login to the services.
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates if the branding is default or custom
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Storage URL location where the sanitized custom css is located
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Storage URL location where the sanitized custom html is located
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Custom translations (JSON String)
  • defaultCompanyNames
    Added In: 18.2.2

    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Default name of the Company in different locales
  • defaultImages
    Added In: 18.2.2

    SCIM++ Properties:
    • idcsCompositeKey: [type]
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    References to various images
  • defaultLoginTexts
    Added In: 18.2.2

    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    Default Login text in different locales
  • Allowed Values: [ "Explicit", "Account", "Tags" ]
    Deprecated Since: 18.3.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    Indicates the default trust scope for all apps
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled.
  • Added In: 2011192329

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Controls whether DiagnosticRecords for external search-operations (against SCIM resource-types in the Admin service) identify returned resources. If true, indicates that for each successful external search-operation at least one DiagnosticRecord will include at least one identifier for each matching resource that is returned in that search-response. If false, no DiagnosticRecord should be expected to identify returned resources for a search-operation. The default value is false.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The end time up to which diagnostic recording is switched on
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCI Domain Id (ocid) in which the resource lives.
  • Added In: 18.2.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if Terms of Use is enabled in UI
  • SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: always
    • type: string
    • uniqueness: global
    Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
  • idcsCreatedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: complex
    The User or App who created the Resource
  • idcsLastModifiedBy
    SCIM++ Properties:
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: complex
    The User or App who modified the Resource
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    The release number when the resource was upgraded.
  • idcsPreventedOperations
    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: true
    • mutability: readOnly
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
  • images
    SCIM++ Properties:
    • idcsCompositeKey: [type]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    References to various images
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if 'hosted' option was selected
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Tenant issuer.
  • Maximum Length: 50
    SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on.
  • loginTexts
    SCIM++ Properties:
    • idcsCompositeKey: [locale]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Login text in different locales
  • Added In: 2111112015

    SCIM++ Properties:
    • idcsMinValue: 0
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    Limit the maximum return of CMVA for an App
  • Added In: 2111112015

    SCIM++ Properties:
    • idcsMinValue: 0
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    Limit the maximum return of members for an AppRole
  • 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.
  • Maximum Length: 200
    Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Database Migration Status
  • 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.
  • Added In: 19.2.1

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    On-Premises provisioning feature toggle.
  • Maximum Length: 50
    SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "languages" and attrValues.value eq "$(preferredLanguage)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Preferred written or spoken language used for localized user interfaces
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: request
    • type: string
    • uniqueness: none
    Previous Tenant issuer. This is an Oracle Identity Cloud Service internal attribute which is not meant to be directly modified by ID Admin. Even if the request body (Settings) contains this attribute, the actual value will be set according to the Oracle Identity Cloud Service internal logic rather than solely based on the value provided in the request payload.
  • Added In: 18.2.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Privacy Policy URL
  • purgeConfigs
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • idcsCompositeKey: [resourceName]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    Purge Configs for different Resource Types
  • reAuthFactor
    Added In: 20.1.3

    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use. Allowed value is \"password\".
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Specifies whether re-authentication is required or not when a user changes one of their security factors such as password or email. Default is true to ensure more secure behavior.
  • 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.
  • Added In: 2108190438

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    By default, a service admin can list all users in stripe. If true, a service admin cannot list other users.
  • Added In: 17.3.4

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    Indicates if access on SigningCert is allowed to public or not
  • Added In: 20.1.3

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Subject mapping user profile attribute. The input format should be SCIM compliant. This attribute should be of type String and multivalued to false.
  • tags
    SCIM++ Properties:
    • idcsCompositeKey: [key, value]
    • idcsSearchable: true
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: request
    • type: complex
    • uniqueness: none
    A list of tags on this resource.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCI Tenant Id (ocid) in which the resource lives.
  • tenantCustomClaims
    Added In: 18.4.2

    SCIM++ Properties:
    • idcsCompositeKey: [name]
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: complex
    • uniqueness: none
    Custom claims associated with the specific tenant
  • Added In: 18.2.4

    SCIM++ Properties:
    • caseExact: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Terms of Use URL
  • Maximum Length: 50
    SCIM++ Properties:
    • caseExact: false
    • idcsCanonicalValueSourceFilter: attrName eq "timezones" and attrValues.value eq "$(timezone)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    User's timezone
Nested Schema : allowedDomains
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
One or more email domains allowed in a user's email field. If unassigned, any domain is allowed.
Show Source
Nested Schema : allowedForgotPasswordFlowReturnUrls
Type: array
Added In: 19.3.3

SCIM++ Properties:
  • type: string
  • multiValued: true
  • required: false
  • mutability: readWrite
  • returned: default
  • uniqueness: none
  • caseExact: false
If specified, indicates the set of Urls which can be returned to after successful forgot password flow
Show Source
Nested Schema : allowedNotificationRedirectUrls
Type: array
Added In: 2009041201

SCIM++ Properties:
  • type: string
  • multiValued: true
  • required: false
  • mutability: readWrite
  • returned: default
  • uniqueness: none
  • caseExact: false
If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of \"notificationRedirectUrl\" in the POST .../admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow.
Show Source
Nested Schema : certificateValidation
Type: object
Added In: 2010242156

SCIM++ Properties:
  • caseExact: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Certificate Validation Config
Show Source
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Use CRL as Fallback.
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    CRL is enabled Configuration
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    CRL Location.
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The CRL refresh interval in minutes
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    OCSP is enabled Configuration
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCSP Responder URL
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    This setting says, OCSP Responder URL present in the issued certificate must be used. Otherwise, OCSP Responder URL from IDP or Settings.
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    OCSP Signing Certificate Alias
  • Added In: 2010242156

    SCIM++ Properties:
    • idcsMaxValue: 10
    • idcsMinValue: 1
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    The OCSP Timeout duration in minutes
  • Added In: 2010242156

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    OCSP Accept unknown response status from ocsp responder.
Nested Schema : cloudGateCorsSettings
Type: object
Added In: 2011192329

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
A complex attribute that specifies the Cloud Gate cross origin resource sharing settings.
Show Source
  • cloudGateCorsAllowedOrigins
    Added In: 2011192329

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Cloud Gate Allowed Cross-Origin Resource Sharing (CORS) Origins for this tenant.
  • Added In: 2011192329

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Allow Null Origin (CORS) for this tenant.
  • Added In: 2011192329

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: boolean
    • uniqueness: none
    Enable Cloud Gate Cross-Origin Resource Sharing (CORS) for this tenant.
  • cloudGateCorsExposedHeaders
    Added In: 2205182039

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    List of Response Headers Cloud Gate is allowed to expose in the CORS Response Header: Access-Control-Expose-Headers.
  • Added In: 2205182039

    SCIM++ Properties:
    • idcsSearchable: false
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: integer
    • uniqueness: none
    Maximum number of seconds a CORS Pre-flight Response may be cached by client.
Nested Schema : companyNames
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Name of the company in different locales
Show Source
Nested Schema : contactEmails
Type: array
SCIM++ Properties:
  • caseExact: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Contact emails used to notify tenants. Can be one or more user or group alias emails.
Show Source
Nested Schema : defaultCompanyNames
Type: array
Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Default name of the Company in different locales
Show Source
Nested Schema : defaultImages
Type: array
Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [type]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
References to various images
Show Source
Nested Schema : defaultLoginTexts
Type: array
Added In: 18.2.2

SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
Default Login text in different locales
Show Source
Nested Schema : idcsCreatedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex
The User or App who created the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    The OCID of the SCIM resource that represents the User or App who created this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that created this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who created this Resource
Nested Schema : idcsLastModifiedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
The User or App who modified the Resource
Show Source
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: reference
    • uniqueness: none
    The URI of the SCIM resource that represents the User or App who modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The displayName of the User or App who modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • returned: default
    • type: string
    • uniqueness: none
    The OCID of the SCIM resource that represents the User or App who modified this Resource
  • Allowed Values: [ "User", "App" ]
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The type of resource, User or App, that modified this Resource
  • SCIM++ Properties:
    • caseExact: true
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    The ID of the SCIM resource that represents the User or App who modified this Resource
Nested Schema : idcsPreventedOperations
Type: array
SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
Allowed Values: [ "replace", "update", "delete" ]
Show Source
Nested Schema : images
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [type]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
References to various images
Show Source
Nested Schema : loginTexts
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [locale]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Login text in different locales
Show Source
Nested Schema : meta
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
  • type: complex
A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
Show Source
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The DateTime the Resource was added to the Service Provider
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: dateTime
    • uniqueness: none
    The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header.
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Name of the resource type of the resource--for example, Users or Groups
  • SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: false
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    The version of the Resource being returned. This value must be the same as the ETag HTTP response header.
Nested Schema : purgeConfigs
Type: array
Deprecated Since: 19.1.6

SCIM++ Properties:
  • idcsCompositeKey: [resourceName]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
Purge Configs for different Resource Types
Show Source
Nested Schema : reAuthFactor
Type: array
Added In: 20.1.3

SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use. Allowed value is \"password\".
Allowed Values: [ "password" ]
Show Source
Nested Schema : schemas
Type: array
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
Show Source
Nested Schema : tags
Type: array
SCIM++ Properties:
  • idcsCompositeKey: [key, value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none
A list of tags on this resource.
Show Source
Nested Schema : tenantCustomClaims
Type: array
Added In: 18.4.2

SCIM++ Properties:
  • idcsCompositeKey: [name]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: complex
  • uniqueness: none
Custom claims associated with the specific tenant
Show Source
Nested Schema : cloudGateCorsAllowedOrigins
Type: array
Added In: 2011192329

SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Cloud Gate Allowed Cross-Origin Resource Sharing (CORS) Origins for this tenant.
Show Source
Nested Schema : cloudGateCorsExposedHeaders
Type: array
Added In: 2205182039

SCIM++ Properties:
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
List of Response Headers Cloud Gate is allowed to expose in the CORS Response Header: Access-Control-Expose-Headers.
Show Source
Nested Schema : companyNames
Type: object
Name of the company in different locales
Show Source
  • SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(companyNames.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 50
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Company name
Nested Schema : defaultCompanyNames
Type: object
Default name of the Company in different locales
Show Source
  • Added In: 18.2.2

    SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(companyNames.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 50
    Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Company name
Nested Schema : defaultImages
Type: object
References to various images
Show Source
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: false
    • returned: default
    • type: string
    A human-readable name, primarily used for display purposes
  • Allowed Values: [ "desktop logo", "mobile logo", "desktop portal header", "mobile portal header", "email header", "email footer", "self registration profile header logo", "self registration profile footer logo" ]
    Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Indicates the image type
  • Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: reference
    Image URI
Nested Schema : defaultLoginTexts
Type: object
Default Login text in different locales
Show Source
  • Added In: 18.2.2

    SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(loginTexts.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 250
    Added In: 18.2.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readOnly
    • required: true
    • returned: default
    • type: string
    • idcsSanitize: true
    Login text
Nested Schema : images
Type: object
References to various images
Show Source
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    A human-readable name, primarily used for display purposes
  • Allowed Values: [ "desktop logo", "mobile logo", "desktop portal header", "mobile portal header", "email header", "email footer", "self registration profile header logo", "self registration profile footer logo", "sign in background image" ]
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Indicates the image type
  • SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: reference
    Image URI
Nested Schema : loginTexts
Type: object
Login text in different locales
Show Source
  • SCIM++ Properties:
    • idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(loginTexts.locale)"
    • idcsCanonicalValueSourceResourceType: AllowedValue
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Locale
  • Maximum Length: 250
    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • idcsSanitize: true
    • type: string
    Login text
Nested Schema : purgeConfigs
Type: object
Purge Configs for different Resource Types
Show Source
  • Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    Resource Name
  • Allowed Values: [ "30", "60", "90" ]
    Deprecated Since: 19.1.6

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: integer
    Retention Period
Nested Schema : tags
Type: object
A list of tags on this resource.
Show Source
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Key or name of the tag.
  • Maximum Length: 256
    SCIM++ Properties:
    • caseExact: false
    • idcsSearchable: true
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Value of the tag.
Nested Schema : tenantCustomClaims
Type: object
Custom claims associated with the specific tenant
Show Source
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if the custom claim is associated with all scopes
  • Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: boolean
    • uniqueness: none
    Indicates if the custom claim is an expression
  • Allowed Values: [ "always", "request", "never" ]
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Indicates under what scenario the custom claim will be return
  • Maximum Length: 100
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: server
    Custom claim name
  • scopes
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: true
    • mutability: readWrite
    • required: false
    • returned: default
    • type: string
    • uniqueness: none
    Scopes associated with a specific custom claim
  • Allowed Values: [ "AT", "IT", "BOTH" ]
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Indicates what type of token the custom claim will be embedded
  • Maximum Length: 100
    Added In: 18.4.2

    SCIM++ Properties:
    • multiValued: false
    • mutability: readWrite
    • required: true
    • returned: default
    • type: string
    • uniqueness: none
    Custom claim value
Nested Schema : scopes
Type: array
Added In: 18.4.2

SCIM++ Properties:
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Scopes associated with a specific custom claim
Show Source

400 Response

Bad or invalid request
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

401 Response

The supplied credentials, if any, are not sufficient to access the resource.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

404 Response

The requested resource could not be found.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

500 Response

We couldn't return the representation due to an internal server error.
Body ()
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Show Source
  • A detailed, human readable message. OPTIONAL
  • schemas
    The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
  • The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
  • urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
    Extension schema for error messages providing more details with the exception status.
    Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type: array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:Error", "urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error" ]
Show Source
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
Back to Top

Examples

The following example shows how to search for tenant settings by submitting a POST request on the REST resource using cURL. Settings include customizing the company name, the login text for the Sign In page, and the language of the text. You can customize the logos that appear on the Sign In page and Console when the user accesses Oracle Identity Cloud Service through a Web browser or mobile device. You can also define the logos that you want to appear in the header and footer regions for all of your email notifications. 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 POST
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/Settings/.search

Example of Request Body

You create searches with a POST request on a resource endpoint ending in /.search by putting the query parameters in the request body. The following shows an example of the request body in JSON format:

{
  "sortOrder": "ASCENDING",
  "pagingCount": 20,
  "pagingStartIndex": 1,
  "sortBy": "attrName",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ],
  "filter": "attrName co \"SEARCH\""
}

Example of Response Body

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

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 3,
  "Resources": [
    {
      "attrName": "citiesPOSTSEARCH1",
      "id": "{id1}",
      "meta": {
        "created": "2015-07-13T07:28:59.227Z",
        "lastModified": "2015-07-13T07:28:59.227Z",
        "resourceType": "AllowedValue",
        "location": "http://tenant-base-url/admin/v1/AllowedValues/{id1}"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:AllowedValue"
      ],
      "dependentAttrs": [
        {
          "attrName": "countries",
          "attrValue": "US"
        },
        {
          "attrName": "region",
          "attrValue": "CA"
        }
      ],
      "attrValues": [
        {
          "value": "SF"
        },
        {
          "value": "RC"
        }
      ]
    },
    {
      "attrName": "citiesPOSTSEARCH2",
      "id": "{id2}",
      "meta": {
        "created": "2015-07-13T07:28:59.227Z",
        "lastModified": "2015-07-13T07:28:59.227Z",
        "resourceType": "AllowedValue",
        "location": "http://tenant-base-url/admin/v1/AllowedValues/{id2}"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:AllowedValue"
      ],
      "dependentAttrs": [
        {
          "attrName": "countries",
          "attrValue": "US"
        },
        {
          "attrName": "region",
          "attrValue": "CA"
        }
      ],
      "attrValues": [
        {
          "value": "SF"
        },
        {
          "value": "RC"
        }
      ]
    },
    {
      "attrName": "citiesPOSTSEARCH3",
      "id": "{id3}",
      "meta": {
        "created": "2015-07-13T07:28:59.227Z",
        "lastModified": "2015-07-13T07:28:59.227Z",
        "resourceType": "AllowedValue",
        "location": "http://tenant-base-url/admin/v1/AllowedValues/{id3}"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:AllowedValue"
      ],
      "dependentAttrs": [
        {
          "attrName": "countries",
          "attrValue": "US"
        },
        {
          "attrName": "region",
          "attrValue": "CA"
        }
      ],
      "attrValues": [
        {
          "value": "SF"
        },
        {
          "value": "RC"
        }
      ]
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 50
}
Back to Top