Search Authentication Factor Settings
get
/admin/v1/AuthenticationFactorSettings
Request
Supported Media Types
- application/json
Query Parameters
-
attributeSets(optional): string
A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive.Allowed Values:
[ "all", "always", "never", "request", "default" ]
-
attributes(optional): string
A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
Header Parameters
-
Authorization: string
The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
-
RESOURCE_TYPE_SCHEMA_VERSION(optional): string
An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Response
Supported Media Types
- application/json
- application/scim+json
200 Response
The request was successful.
Root Schema : AuthenticationFactorSettings-ListResponse
Type:
object
The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI.
Show Source
-
itemsPerPage:
integer
The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.
-
Resources:
array Resources
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
startIndex:
integer
The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.
-
totalResults:
integer
The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED.
Nested Schema : Resources
Type:
array
A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.
Show Source
-
Array of:
object AuthenticationFactorSettings
Multi Factor Authentication Settings for Tenant
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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
Nested Schema : AuthenticationFactorSettings
Type:
object
Multi Factor Authentication Settings for Tenant
Show Source
-
autoEnrollEmailFactorDisabled(optional):
boolean
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
bypassCodeEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
bypassCodeSettings:
object bypassCodeSettings
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
clientAppSettings:
object clientAppSettings
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
compliancePolicy:
array compliancePolicy
SCIM++ Properties:
- idcsCompositeKey: [name]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
deleteInProgress(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
domainOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
emailEnabled(optional):
boolean
Added In: 18.1.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
emailSettings(optional):
object emailSettings
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
endpointRestrictions:
object endpointRestrictions
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
fidoAuthenticatorEnabled(optional):
boolean
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
hideBackupFactorEnabled(optional):
boolean
Added In: 19.3.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- 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
-
identityStoreSettings(optional):
object identityStoreSettings
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- 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
-
mfaEnabledCategory(optional):
string
Deprecated Since: 18.1.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
mfaEnrollmentType:
string
Deprecated Since: 18.1.2
SCIM++ Properties:- idcsCanonicalValueSourceFilter: attrName eq "mfaEnrollmentType" and attrValues.value eq "$(mfaEnrollmentType)"
- idcsCanonicalValueSourceResourceType: AllowedValue
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
notificationSettings:
object notificationSettings
Added In: 17.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- 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
-
phoneCallEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
pushEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- 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
-
securityQuestionsEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
smsEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- 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
-
thirdPartyFactor(optional):
object thirdPartyFactor
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
totpEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
totpSettings:
object totpSettings
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings
This extension defines attributes used to manage Multi-Factor Authentication settings of fido authentication
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings
This extension defines attributes used to manage Multi-Factor Authentication settings of third party provider
-
userEnrollmentDisabledFactors(optional):
array userEnrollmentDisabledFactors
Added In: 2012271618
SCIM++ Properties:- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
yubicoOtpEnabled(optional):
boolean
Added In: 2109090424
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : bypassCodeSettings
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
helpDeskCodeExpiryInMins:
integer
SCIM++ Properties:
- idcsMaxValue: 9999999
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
helpDeskGenerationEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
helpDeskMaxUsage:
integer
SCIM++ Properties:
- idcsMaxValue: 999
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
length:
integer
SCIM++ Properties:
- idcsMaxValue: 20
- idcsMinValue: 8
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
maxActive:
integer
SCIM++ Properties:
- idcsMaxValue: 6
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
selfServiceGenerationEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : clientAppSettings
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
deviceProtectionPolicy:
string
SCIM++ Properties:
- idcsCanonicalValueSourceFilter: attrName eq "deviceProtectionPolicy" and attrValues.value eq "$(deviceProtectionPolicy)"
- idcsCanonicalValueSourceResourceType: AllowedValue
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
initialLockoutPeriodInSecs:
integer
SCIM++ Properties:
- idcsMaxValue: 86400
- idcsMinValue: 30
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
keyPairLength:
integer
SCIM++ Properties:
- idcsMaxValue: 4000
- idcsMinValue: 32
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
lockoutEscalationPattern:
string
SCIM++ Properties:
- idcsCanonicalValueSourceFilter: attrName eq "lockoutEscalationPattern" and attrValues.value eq "$(lockoutEscalationPattern)"
- idcsCanonicalValueSourceResourceType: AllowedValue
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
maxFailuresBeforeLockout:
integer
SCIM++ Properties:
- idcsMaxValue: 10
- idcsMinValue: 5
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
maxFailuresBeforeWarning:
integer
SCIM++ Properties:
- idcsMaxValue: 10
- idcsMinValue: 0
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
maxLockoutIntervalInSecs:
integer
SCIM++ Properties:
- idcsMaxValue: 86400
- idcsMinValue: 30
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
minPinLength:
integer
SCIM++ Properties:
- idcsMaxValue: 10
- idcsMinValue: 6
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
policyUpdateFreqInDays:
integer
SCIM++ Properties:
- idcsMaxValue: 999
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
requestSigningAlgo:
string
Allowed Values:
[ "SHA256withRSA", "SHA384withRSA", "SHA512withRSA" ]
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
- sharedSecretEncoding: string
-
unlockAppForEachRequestEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
unlockAppIntervalInSecs:
integer
SCIM++ Properties:
- idcsMaxValue: 9999999
- idcsMinValue: 0
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
unlockOnAppForegroundEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
unlockOnAppStartEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : compliancePolicy
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [name]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object compliancePolicy
Compliance Policy that defines actions to be taken when a condition is violated
Nested Schema : emailSettings
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
emailLinkCustomUrl(optional):
string
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
emailLinkEnabled:
boolean
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : endpointRestrictions
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
maxEndpointTrustDurationInDays:
integer
SCIM++ Properties:
- idcsMaxValue: 180
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
maxEnrolledDevices:
integer
SCIM++ Properties:
- idcsMaxValue: 20
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
maxIncorrectAttempts:
integer
SCIM++ Properties:
- idcsMaxValue: 20
- idcsMinValue: 5
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
maxTrustedEndpoints:
integer
SCIM++ Properties:
- idcsMaxValue: 20
- idcsMinValue: 1
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
trustedEndpointsEnabled:
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : idcsCreatedBy
Type:
object
SCIM++ Properties:
Show Source
- 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
Nested Schema : idcsLastModifiedBy
Type:
object
SCIM++ Properties:
Show Source
- 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
Nested Schema : idcsPreventedOperations
Type:
array
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"replace",
"update",
"delete"
]
Nested Schema : identityStoreSettings
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
mobileNumberEnabled(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
mobileNumberUpdateEnabled(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : meta
Type:
object
SCIM++ Properties:
Show Source
- 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
Nested Schema : notificationSettings
Type:
object
Added In: 17.4.2
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
pullEnabled:
boolean
Added In: 17.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : schemas
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : thirdPartyFactor
Type:
object
Added In: 19.2.1
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
duoSecurity:
boolean
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : totpSettings
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
emailOtpValidityDurationInMins:
integer
Added In: 18.1.2
SCIM++ Properties:- idcsMaxValue: 60
- idcsMinValue: 2
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
emailPasscodeLength:
integer
Added In: 18.1.2
SCIM++ Properties:- idcsMaxValue: 10
- idcsMinValue: 4
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
hashingAlgorithm:
string
Allowed Values:
[ "SHA1", "SHA256", "SHA384", "SHA512", "MD5" ]
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
jwtValidityDurationInSecs:
integer
SCIM++ Properties:
- idcsMaxValue: 99999
- idcsMinValue: 30
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
keyRefreshIntervalInDays:
integer
SCIM++ Properties:
- idcsMaxValue: 999
- idcsMinValue: 30
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
passcodeLength:
integer
SCIM++ Properties:
- idcsMaxValue: 10
- idcsMinValue: 4
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
smsOtpValidityDurationInMins:
integer
SCIM++ Properties:
- idcsMaxValue: 60
- idcsMinValue: 2
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
smsPasscodeLength:
integer
SCIM++ Properties:
- idcsMaxValue: 10
- idcsMinValue: 4
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
timeStepInSecs:
integer
SCIM++ Properties:
- idcsMaxValue: 300
- idcsMinValue: 30
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
-
timeStepTolerance:
integer
SCIM++ Properties:
- idcsMaxValue: 3
- idcsMinValue: 2
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: integer
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings
Type:
object
This extension defines attributes used to manage Multi-Factor Authentication settings of fido authentication
Show Source
-
attestation:
string
Allowed Values:
[ "NONE", "DIRECT", "INDIRECT" ]
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
authenticatorSelectionAttachment:
string
Allowed Values:
[ "PLATFORM", "CROSS-PLATFORM", "BOTH" ]
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
authenticatorSelectionRequireResidentKey:
boolean
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
authenticatorSelectionResidentKey:
string
Allowed Values:
[ "REQUIRED", "PREFERRED", "DISCOURAGED", "NONE" ]
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
authenticatorSelectionUserVerification:
string
Allowed Values:
[ "REQUIRED", "PREFERRED", "DISCOURAGED" ]
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
domainValidationLevel(optional):
integer
Added In: 2109020413
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- idcsMaxValue: 2
- idcsMinValue: 0
- required: false
- returned: default
- type: integer
- uniqueness: none
-
excludeCredentials:
boolean
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
publicKeyTypes:
array publicKeyTypes
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
timeout:
integer
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- idcsMaxValue: 600000
- idcsMinValue: 10000
- required: true
- returned: default
- type: integer
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings
Type:
object
This extension defines attributes used to manage Multi-Factor Authentication settings of third party provider
Show Source
-
duoSecuritySettings(optional):
object duoSecuritySettings
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : userEnrollmentDisabledFactors
Type:
array
Added In: 2012271618
SCIM++ Properties:
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"EMAIL",
"SMS",
"TOTP",
"PUSH",
"OFFLINETOTP",
"VOICE",
"PHONE_CALL",
"THIRDPARTY",
"FIDO_AUTHENTICATOR"
]
Nested Schema : compliancePolicy
Type:
object
Compliance Policy that defines actions to be taken when a condition is violated
Show Source
-
action:
string
Allowed Values:
[ "Allow", "Block", "Notify", "None" ]
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
name:
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : publicKeyTypes
Type:
array
Added In: 2009232244
SCIM++ Properties:
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"RS1",
"RS256",
"ES256"
]
Nested Schema : duoSecuritySettings
Type:
object
Added In: 19.2.1
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
apiHostname:
string
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
attestationKey(optional):
string
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: string
- uniqueness: none
-
integrationKey:
string
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
secretKey:
string
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
userMappingAttribute:
string
Allowed Values:
[ "primaryEmail", "userName", "givenName" ]
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
400 Response
Bad or invalid request
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.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
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.
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.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
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.
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.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
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.
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.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
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:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
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
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.
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.