Search Settings Using POST
/admin/v1/Settings/.search
Request
- application/scim+json
- application/json
-
Authorization: string
The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
-
Content-Type: string
Media Type
-
RESOURCE_TYPE_SCHEMA_VERSION(optional): string
An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
object
-
attributes(optional):
array 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(optional):
array 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:
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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.
array
array
[
"all",
"always",
"never",
"request",
"default"
]
array
[
"urn:ietf:params:scim:api:messages:2.0:SearchRequest"
]
Response
- application/json
- application/scim+json
200 Response
object
-
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.
array
-
Array of:
object Settings
Settings schema
array
[
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
object
-
accountAlwaysTrustScope(optional):
boolean
Added In: 18.1.6
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
allowedDomains(optional):
array allowedDomains
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
allowedForgotPasswordFlowReturnUrls(optional):
array allowedForgotPasswordFlowReturnUrls
Added In: 19.3.3
SCIM++ Properties:- type: string
- multiValued: true
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
- caseExact: false
-
allowedNotificationRedirectUrls(optional):
array allowedNotificationRedirectUrls
Added In: 2009041201
SCIM++ Properties:- type: string
- multiValued: true
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
- caseExact: false
-
auditEventRetentionPeriod(optional):
integer
Allowed Values:
[ "30", "60", "90" ]
Added In: 19.2.1
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
-
certificateValidation(optional):
object certificateValidation
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
cloudAccountName(optional):
string
Deprecated Since: 2011192329
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
cloudGateCorsSettings(optional):
object cloudGateCorsSettings
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
cloudMigrationCustomUrl(optional):
string
Added In: 2012271618
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
- caseExact: false
-
cloudMigrationUrlEnabled(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
companyNames(optional):
array companyNames
SCIM++ Properties:
- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
contactEmails(optional):
array contactEmails
SCIM++ Properties:
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
csrAccess:
string
Allowed Values:
[ "readOnly", "readWrite", "none" ]
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
-
customBranding(optional):
boolean
SCIM++ Properties:
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
customCssLocation(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
customHtmlLocation(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
customTranslation(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
defaultCompanyNames(optional):
array defaultCompanyNames
Added In: 18.2.2
SCIM++ Properties:- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
defaultImages(optional):
array defaultImages
Added In: 18.2.2
SCIM++ Properties:- idcsCompositeKey: [type]
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
defaultLoginTexts(optional):
array defaultLoginTexts
Added In: 18.2.2
SCIM++ Properties:- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
defaultTrustScope(optional):
string
Allowed Values:
[ "Explicit", "Account", "Tags" ]
Deprecated Since: 18.3.6
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
-
deleteInProgress(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
diagnosticLevel(optional):
integer
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
diagnosticRecordForSearchIdentifiesReturnedResources(optional):
boolean
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
diagnosticTracingUpto(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
domainOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
enableTermsOfUse(optional):
boolean
Added In: 18.2.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
id(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: global
-
idcsCreatedBy:
object idcsCreatedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
idcsLastModifiedBy(optional):
object idcsLastModifiedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
idcsLastUpgradedInRelease(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
idcsPreventedOperations(optional):
array idcsPreventedOperations
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
images(optional):
array images
SCIM++ Properties:
- idcsCompositeKey: [type]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
isHostedPage(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
issuer(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
locale(optional):
string
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
-
loginTexts(optional):
array loginTexts
SCIM++ Properties:
- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
maxNoOfAppCMVAToReturn(optional):
integer
Added In: 2111112015
SCIM++ Properties:- idcsMinValue: 0
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
maxNoOfAppRoleMembersToReturn(optional):
integer
Added In: 2111112015
SCIM++ Properties:- idcsMinValue: 0
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
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
-
migrationStatus(optional):
string
Maximum Length:
200
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
Maximum Length:
255
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: string
- uniqueness: global
-
onPremisesProvisioning(optional):
boolean
Added In: 19.2.1
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
preferredLanguage(optional):
string
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
-
prevIssuer(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: string
- uniqueness: none
-
privacyPolicyUrl(optional):
string
Added In: 18.2.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
purgeConfigs(optional):
array purgeConfigs
Deprecated Since: 19.1.6
SCIM++ Properties:- idcsCompositeKey: [resourceName]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
reAuthFactor(optional):
array reAuthFactor
Added In: 20.1.3
SCIM++ Properties:- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
-
reAuthWhenChangingMyAuthenticationFactors(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
schemas:
array schemas
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
serviceAdminCannotListOtherUsers(optional):
boolean
Added In: 2108190438
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
signingCertPublicAccess(optional):
boolean
Added In: 17.3.4
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
-
subMappingAttr(optional):
string
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
tags(optional):
array tags
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
tenancyOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
tenantCustomClaims(optional):
array tenantCustomClaims
Added In: 18.4.2
SCIM++ Properties:- idcsCompositeKey: [name]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
termsOfUseUrl(optional):
string
Added In: 18.2.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
timezone(optional):
string
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
array
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
array
SCIM++ Properties:
- type: string
- multiValued: true
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
- caseExact: false
array
SCIM++ Properties:
- type: string
- multiValued: true
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
- caseExact: false
object
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
crlCheckOnOCSPFailureEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
crlEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
crlLocation(optional):
string
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
crlRefreshInterval(optional):
integer
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
ocspEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspResponderURL(optional):
string
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocspSettingsResponderURLPreferred(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspSigningCertificateAlias(optional):
string
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocspTimeoutDuration(optional):
integer
Added In: 2010242156
SCIM++ Properties:- idcsMaxValue: 10
- idcsMinValue: 1
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
ocspUnknownResponseStatusAllowed(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
object
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
cloudGateCorsAllowedOrigins(optional):
array cloudGateCorsAllowedOrigins
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
cloudGateCorsAllowNullOrigin(optional):
boolean
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
cloudGateCorsEnabled(optional):
boolean
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
cloudGateCorsExposedHeaders(optional):
array cloudGateCorsExposedHeaders
Added In: 2205182039
SCIM++ Properties:- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
cloudGateCorsMaxAge(optional):
integer
Added In: 2205182039
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
array
- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object companyNames
Name of the company in different locales
array
- caseExact: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
array
SCIM++ Properties:
- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
Array of:
object defaultCompanyNames
Default name of the Company in different locales
array
SCIM++ Properties:
- idcsCompositeKey: [type]
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
Array of:
object defaultImages
References to various images
array
SCIM++ Properties:
- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
Array of:
object defaultLoginTexts
Default Login text in different locales
object
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
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
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
object
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
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
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
array
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
[
"replace",
"update",
"delete"
]
array
- idcsCompositeKey: [type]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object images
References to various images
array
- idcsCompositeKey: [locale]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object loginTexts
Login text in different locales
object
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
- type: complex
-
created(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
lastModified(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
location(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
resourceType(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
version(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
array
SCIM++ Properties:
- idcsCompositeKey: [resourceName]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
-
Array of:
object purgeConfigs
Purge Configs for different Resource Types
array
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
[
"password"
]
array
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
array
SCIM++ Properties:
- idcsCompositeKey: [name]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object tenantCustomClaims
Custom claims associated with the specific tenant
array
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
array
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
object
-
locale:
string
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
-
value:
string
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
object
-
locale:
string
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
-
value:
string
Maximum Length:
50
Added In: 18.2.2
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
object
-
display(optional):
string
Added In: 18.2.2
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
-
type:
string
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
-
value:
string
Added In: 18.2.2
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: reference
object
-
locale:
string
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
-
value:
string
Maximum Length:
250
Added In: 18.2.2
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
object
-
display(optional):
string
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
-
type:
string
Allowed Values:
[ "desktop logo", "mobile logo", "desktop portal header", "mobile portal header", "email header", "email footer", "sign in background image" ]
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
-
value:
string
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: reference
object
-
locale:
string
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
-
value:
string
SCIM++ Properties:
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
object
-
resourceName:
string
Deprecated Since: 19.1.6
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
-
retentionPeriod:
integer
Allowed Values:
[ "30", "60", "90" ]
Deprecated Since: 19.1.6
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
object
-
allScopes:
boolean
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
expression:
boolean
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
mode:
string
Allowed Values:
[ "always", "request", "never" ]
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
name:
string
Maximum Length:
100
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: server
-
scopes(optional):
array scopes
Added In: 18.4.2
SCIM++ Properties:- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
tokenType:
string
Allowed Values:
[ "AT", "IT", "BOTH" ]
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Maximum Length:
100
Added In: 18.4.2
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
array
SCIM++ Properties:
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
400 Response
object
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.
-
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.
array
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
object
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.
-
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.
object
401 Response
object
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.
-
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.
array
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
object
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.
-
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.
object
404 Response
object
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.
-
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.
array
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
object
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.
-
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.
object
500 Response
object
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.
-
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.
array
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
object
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.
-
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.
object
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 structurehttps://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
}