Check Password of Specified User or App
/admin/v1/PasswordAuthenticator
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.
Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute.
- Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable:
- The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly.
- The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly.
- Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.
Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below:
- Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always:
- If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always.
- If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always.
- The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.
object
-
accountRecoveryRequired(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
appDisplayName(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: true
- caseExact: false
- uniqueness: none
-
appId(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: true
- caseExact: false
- uniqueness: none
-
applicableAuthenticationTargetApp(optional):
object applicableAuthenticationTargetApp
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
applicableFactors:
array applicableFactors
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
appName(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: true
- caseExact: false
- uniqueness: none
-
appRoles(optional):
array appRoles
SCIM++ Properties:
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- uniqueness: none
-
appServiceInstanceIdentifier(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: false
- caseExact: false
- uniqueness: none
-
city(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
clientIp(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
- idcsSearchable: false
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
country(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
csr(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
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
-
groups(optional):
array groups
SCIM++ Properties:
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- 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
-
includeMemberships(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
includeMfaAttributes(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
includeSFFAuthKeys(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
isOCIConsoleClient(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
isPolicyRequired(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: writeOnly
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
locale(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
mappingAttribute(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
-
mappingAttributeValue:
string
Minimum Length:
1
Maximum Length:256
SCIM++ Properties:- type: string
- multiValued: false
- required: true
- mutability: readWrite
- returned: default
- 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
-
mfaIgnoredApps(optional):
array mfaIgnoredApps
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaPreferredAuthenticationFactor(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaPreferredDevice(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaPreferredThirdPartyVendorName(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaStatus(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- 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
-
password:
string
Minimum Length:
1
Maximum Length:500
SCIM++ Properties:- type: string
- multiValued: false
- required: true
- mutability: writeOnly
- returned: never
- idcsSensitive: hash
- uniqueness: none
-
postalCode(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
preferredLanguage(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
primaryEmailVerified(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- 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
-
securityQuestionsPresent(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
sffAuthKeys(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
state(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
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
-
tenantName(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
timezone(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
userAllowedToSetRecoveryEmail(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
userDisplayName(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
userEmail(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: always
- uniqueness: none
- idcsPii: true
-
userLocaleAsEntered(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- caseExact: true
- idcsSearchable: false
-
userName(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsPii: true
-
userPreferredLanguageAsEntered(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- caseExact: true
- idcsSearchable: false
object
- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- returned: default
- type: string
- uniqueness: none
array
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
array
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- uniqueness: none
-
Array of:
object appRoles
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
array
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- uniqueness: none
-
Array of:
object groups
A list of groups of which the User or App is a member, either thorough direct membership, nested groups, or dynamically calculated
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"
]
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
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
array
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
object
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: reference
- uniqueness: none
-
adminRole(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
appId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
appName(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
legacyGroupName(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "direct", "indirect" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
value:
string
Maximum Length:
40
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
object
-
$ref(optional):
string
SCIM++ Properties:
- type: reference
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
display(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
externalId(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
nonUniqueDisplay(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
type:
string
Allowed Values:
[ "direct", "indirect" ]
SCIM++ Properties:- type: string
- multiValued: false
- required: true
- mutability: readOnly
- returned: request
- uniqueness: none
- idcsSearchable: true
-
value:
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: true
- caseExact: false
- mutability: readOnly
- idcsSearchable: true
- returned: default
- uniqueness: none
Response
- application/json
- application/scim+json
201 Response
object
-
accountRecoveryRequired(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
appDisplayName(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: true
- caseExact: false
- uniqueness: none
-
appId(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: true
- caseExact: false
- uniqueness: none
-
applicableAuthenticationTargetApp(optional):
object applicableAuthenticationTargetApp
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
applicableFactors:
array applicableFactors
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
appName(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: true
- caseExact: false
- uniqueness: none
-
appRoles(optional):
array appRoles
SCIM++ Properties:
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- uniqueness: none
-
appServiceInstanceIdentifier(optional):
string
Minimum Length:
2
Maximum Length:100
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- idcsSearchable: false
- caseExact: false
- uniqueness: none
-
city(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
clientIp(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
- idcsSearchable: false
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
country(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
csr(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
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
-
groups(optional):
array groups
SCIM++ Properties:
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- 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
-
includeMemberships(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
includeMfaAttributes(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
includeSFFAuthKeys(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
isOCIConsoleClient(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: writeOnly
- returned: never
- uniqueness: none
-
isPolicyRequired(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: writeOnly
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
locale(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
mappingAttribute(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readWrite
- returned: default
- uniqueness: none
-
mappingAttributeValue:
string
Minimum Length:
1
Maximum Length:256
SCIM++ Properties:- type: string
- multiValued: false
- required: true
- mutability: readWrite
- returned: default
- 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
-
mfaIgnoredApps(optional):
array mfaIgnoredApps
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaPreferredAuthenticationFactor(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaPreferredDevice(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaPreferredThirdPartyVendorName(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
mfaStatus(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- 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
-
password:
string
Minimum Length:
1
Maximum Length:500
SCIM++ Properties:- type: string
- multiValued: false
- required: true
- mutability: writeOnly
- returned: never
- idcsSensitive: hash
- uniqueness: none
-
postalCode(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
preferredLanguage(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
primaryEmailVerified(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- 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
-
securityQuestionsPresent(optional):
boolean
SCIM++ Properties:
- type: boolean
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
sffAuthKeys(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
state(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- idcsPii: true
-
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
-
tenantName(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
timezone(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
userAllowedToSetRecoveryEmail(optional):
boolean
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
userDisplayName(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
-
userEmail(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: always
- uniqueness: none
- idcsPii: true
-
userLocaleAsEntered(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- caseExact: true
- idcsSearchable: false
-
userName(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsPii: true
-
userPreferredLanguageAsEntered(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- caseExact: true
- idcsSearchable: false
object
- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- returned: default
- type: string
- uniqueness: none
array
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
array
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- uniqueness: none
-
Array of:
object appRoles
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
array
- type: complex
- multiValued: true
- required: false
- idcsCompositeKey: [value]
- mutability: readOnly
- returned: request
- uniqueness: none
-
Array of:
object groups
A list of groups of which the User or App is a member, either thorough direct membership, nested groups, or dynamically calculated
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"
]
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
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
array
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
object
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: reference
- uniqueness: none
-
adminRole(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
appId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
appName(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
legacyGroupName(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "direct", "indirect" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
value:
string
Maximum Length:
40
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
object
-
$ref(optional):
string
SCIM++ Properties:
- type: reference
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
display(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
externalId(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
nonUniqueDisplay(optional):
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: false
- mutability: readOnly
- returned: default
- uniqueness: none
- idcsSearchable: false
-
type:
string
Allowed Values:
[ "direct", "indirect" ]
SCIM++ Properties:- type: string
- multiValued: false
- required: true
- mutability: readOnly
- returned: request
- uniqueness: none
- idcsSearchable: true
-
value:
string
SCIM++ Properties:
- type: string
- multiValued: false
- required: true
- caseExact: false
- mutability: readOnly
- idcsSearchable: true
- returned: default
- 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 check the password of a user or an app by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
cURL Command
Note:
The command in this example uses the URL 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/PasswordAuthenticator
Example of Request Body
User Examples
The following shows an example of the request body in JSON format to check the password for a specified user:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "admin@example.com",
"password": "Welc0me@1",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "707b11e73504407f9dd66fcfc5cc6a9b",
"userEmail": "admin@example.com",
"userDisplayName": "admin opc",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago",
"csr": false,
"tenantName": "integtenant",
"type": "User",
"mappingAttributeValue": "admin@example.com",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Request Body
The following shows an example of the request body in JSON format to check the password for a specific user who has approles assigned.
{
"mappingAttributeValue": "admin@example.com",
"password": "Welc0me@1",
"schemas": ["urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"],
"includeMemberships": true
}
Example Response Body
The following example shows the contents of the response body in JSON format where the user has three approles assigned. There is no filtering criteria supplied, so all approle memberships are returned in the response:
{
"id": "ac3f20f1b4ce427188885047e042752f",
"userEmail": "admin@example.com",
"userDisplayName": "admin opc",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago",
"csr": false,
"tenantName": "tenant1",
"type": "User",
"mappingAttributeValue": "admin@example.com",
"mappingAttribute": "userName",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
],
"groups": [
{
"display": "OPCAPP1.Administrator for OPCApp1",
"value": "e75096b138cb407ebe018c69fdd55fa0",
"$ref": "https://tenant-base-url/admin/v1/IDSGroups/e75096b138cb407ebe018c69fdd55fa0"
}
,
{
"display": "OPCAPP2.Administrator for OPCApp2",
"value": "4b8eb6efd4444833ba8716cc1b3260a6",
"$ref": "https://tenant-base-url/admin/v1/IDSGroups/4b8eb6efd4444833ba8716cc1b3260a6"
}
],
"appRoles": [
{
"value": "61b9ec56053f459dbf6496b889a8943f",
"adminRole": true,
"appId": "IDCSAppId",
"appName": "IDCSApp",
"display": "Identity Domain Administrator",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/61b9ec56053f459dbf6496b889a8943f"
}
,
{
"value": "e75096b138cb407ebe018c69fdd55fa0",
"adminRole": true,
"legacyGroupName": "OPCAPP1.Administrator for OPCApp1",
"appId": "5744effc0d50468fbe2b60bad84e4234",
"appName": "OPCAPP1_APPID",
"display": "Administrator for OPCApp1",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/e75096b138cb407ebe018c69fdd55fa0"
}
,
{
"value": "4b8eb6efd4444833ba8716cc1b3260a6",
"adminRole": true,
"legacyGroupName": "OPCAPP2.Administrator for OPCApp2",
"appId": "8e741ce1e1a542149a436de70d08966e",
"appName": "OPCAPP2_APPID",
"display": "Administrator for OPCApp2",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/4b8eb6efd4444833ba8716cc1b3260a6"
}
]
}
Example Request Body
The following example shows the contents of a request to check the password of a user where the App service instance identifier is included in the filter criteria:
{
"mappingAttributeValue": "admin@example.com",
"password": "Welc0me@1",
"schemas": ["urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"],
"includeMemberships": true,
"appServiceInstanceIdentifier": "0436F9D6C3F04E6ABD0E5F19492565EA"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "ac3f20f1b4ce427188885047e042752f",
"userEmail": "admin@example.com",
"userDisplayName": "admin opc",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago",
"csr": false,
"tenantName": "tenant1",
"type": "User",
"mappingAttributeValue": "admin@example.com",
"mappingAttribute": "userName",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
],
"groups": [
{
"display": "OPCAPP1.Administrator for OPCApp1",
"value": "e75096b138cb407ebe018c69fdd55fa0",
"$ref": "https://tenant-base-url/admin/v1/IDSGroups/e75096b138cb407ebe018c69fdd55fa0"
}
],
"appRoles": [
{
"value": "e75096b138cb407ebe018c69fdd55fa0",
"adminRole": true,
"legacyGroupName": "OPCAPP1.Administrator for OPCApp1",
"appId": "5744effc0d50468fbe2b60bad84e4234",
"appName": "OPCAPP1_APPID",
"display": "Administrator for OPCApp1",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/e75096b138cb407ebe018c69fdd55fa0"
}
]
}
Example Request Body
The following example shows the contents of a request to check the password of a user with invalid credentials:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "jdoe",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the invalid credentials response body in JSON format:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "INVALID_CREDENTIALS",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"additionalData": {
"csr": false,
"tenantName": "integtenant",
"id": "856d1aec99364d4981ca8509def64a00",
"displayName": "John Doe",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago"
}
}
}
Example Request Body
The following example shows the contents of a request to check the password of a user with a disabled account:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "jdoe",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the user disabled response body in JSON format:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "USER_DISABLED_RESPONSE",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"additionalData": {
"csr": false,
"tenantName": "integtenant",
"id": "856d1aec99364d4981ca8509def64a00",
"displayName": "John Doe",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago"
}
}
}
Example Request Body
The following example shows the contents of a request to check a password for a user that isn???t found:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "jdoe",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the user not found response:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "USER_NOT_FOUND",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"additionalData": {
"csr": false,
"tenantName": "integtenant"
}
}
}
Example Request Body
The following example shows the contents of a request to check a password for a user that is locked:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "jdoe",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the user locked response:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "USER_LOCKED_RESPONSE",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"additionalData": {
"csr": false,
"tenantName": "integtenant",
"id": "856d1aec99364d4981ca8509def64a00",
"displayName": "John Doe",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago"
}
}
}
Example Request Body
The following example shows the contents of a request to check a password for a user who must change their password:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "jdoe",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the password must change response:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "PASSWORD_MUST_CHANGE_RESPONSE",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"additionalData": {
"csr": false,
"tenantName": "integtenant",
"id": "856d1aec99364d4981ca8509def64a00",
"displayName": "John Doe",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago"
}
}
}
Example Request Body
The following example shows the contents of a request to check a password for a user with an expired password:
{
"mappingAttribute": "userName",
"mappingAttributeValue": "jdoe",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the password expired response:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "PASSWORD_EXPIRED_RESPONSE",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"additionalData": {
"csr": false,
"tenantName": "integtenant",
"id": "856d1aec99364d4981ca8509def64a00",
"displayName": "John Doe",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago"
}
}
}
Example Request Body
The following example shows the contents of a request that includes the includeMemberships for the IDCSApp app:
{
"mappingAttributeValue": "admin@example.com",
"password": "Welc0me@1",
"includeMemberships": true,
"appName": "IDCSApp",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the response body in JSON format from a request that includes the includeMemberships for the IDCSApp app:
{
"id": "707b11e73504407f9dd66fcfc5cc6a9b",
"userEmail": "admin@example.com",
"userDisplayName": "admin opc",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago",
"csr": false,
"tenantName": "integtenant",
"type": "User",
"mappingAttributeValue": "admin@example.com",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
],
"groups": [
{
"display": "TenantAdminGroup",
"value": "e024aa4fc54440389a187a49cfb32018",
"$ref": "http://tenant-base-url/admin/v1/IDSGroups/e024aa4fc54440389a187a49cfb32018"
}
],
"appRoles": [
{
"value": "b3b3ab5e71b3462a8c19bea7ffbd90dd",
"$ref": "http://tenant-base-url/admin/v1/AppRoles/b3b3ab5e71b3462a8c19bea7ffbd90dd",
"appName": "IDCSApp",
"display": "Identity Domain Administrator",
"appId": "IDCSAppId",
"adminRole": true,
"legacyGroupName": "TenantAdminGroup"
}
]
}
Example Request Body
The following example shows the contents of a request body in JSON format that includes the includeMemberships for the Identity Domain Administrator app:
{
"mappingAttributeValue": "admin@example.com",
"password": "Welc0me@1",
"includeMemberships": true,
"appDisplayName": "Identity Domain Administrator",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the response body in JSON format from a request that includes the includeMemberships for the Identity Domain Administrator app:
{
"id": "707b11e73504407f9dd66fcfc5cc6a9b",
"userEmail": "admin@example.com",
"userDisplayName": "admin opc",
"locale": "en",
"preferredLanguage": "en",
"timezone": "America/Chicago",
"csr": false,
"tenantName": "integtenant",
"type": "User",
"mappingAttributeValue": "admin@example.com",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
],
"groups": [
{
"display": "TenantAdminGroup",
"value": "e024aa4fc54440389a187a49cfb32018",
"$ref": "http://tenant-base-url/admin/v1/IDSGroups/e024aa4fc54440389a187a49cfb32018"
}
],
"appRoles": [
{
"value": "b3b3ab5e71b3462a8c19bea7ffbd90dd",
"$ref": "http://tenant-base-url/admin/v1/AppRoles/b3b3ab5e71b3462a8c19bea7ffbd90dd",
"appName": "IDCSApp",
"display": "Identity Domain Administrator",
"appId": "IDCSAppId",
"adminRole": true,
"legacyGroupName": "TenantAdminGroup"
}
]
}
App Examples
Example Request Body
The following example shows the contents of a request body in JSON format for an app that has approles assigned and specifying no filter criteria:
{
"mappingAttributeValue": "TestAPP1_APPID",
"password": "f864d2df-2a8f-44d6-aaed-d04d08df81d2",
"schemas": ["urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"],
"includeMemberships": true
}
Example Response Body
The following example shows the contents of the response body in JSON format for an app that has two approles assigned:
{
"mappingAttributeValue": "TestAPP1_APPID",
"mappingAttribute": "name",
"tenantName": "tenant1",
"type": "App",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
],
"groups": [
{
"display": "OPCAPP1.Administrator for OPCApp1",
"value": "e75096b138cb407ebe018c69fdd55fa0",
"type": "direct",
"$ref": "https://tenant-base-url/admin/v1/IDSGroups/e75096b138cb407ebe018c69fdd55fa0"
}
,
{
"display": "OPCAPP2.Administrator for OPCApp2",
"value": "4b8eb6efd4444833ba8716cc1b3260a6",
"type": "direct",
"$ref": "https://tenant-base-url/admin/v1/IDSGroups/4b8eb6efd4444833ba8716cc1b3260a6"
}
],
"appRoles": [
{
"value": "e75096b138cb407ebe018c69fdd55fa0",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/e75096b138cb407ebe018c69fdd55fa0",
"appId": "5744effc0d50468fbe2b60bad84e4234",
"display": "Administrator for OPCApp1",
"type": "direct",
"appName": "OPCAPP1_APPID",
"adminRole": true,
"legacyGroupName": "OPCAPP1.Administrator for OPCApp1"
}
,
{
"value": "4b8eb6efd4444833ba8716cc1b3260a6",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/4b8eb6efd4444833ba8716cc1b3260a6",
"appId": "8e741ce1e1a542149a436de70d08966e",
"display": "Administrator for OPCApp2",
"type": "direct",
"appName": "OPCAPP2_APPID",
"adminRole": true,
"legacyGroupName": "OPCAPP2.Administrator for OPCApp2"
}
]
}
Example Request Body
The following example shows the contents of a request body in JSON format for an app where the appServiceInstanceIdentifier is specified as filter criteria:
{
"mappingAttributeValue": "TestAPP1_APPID",
"password": "f864d2df-2a8f-44d6-aaed-d04d08df81d2",
"schemas": ["urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"],
"includeMemberships": true,
"appServiceInstanceIdentifier": "0436F9D6C3F04E6ABD0E5F19492565EA"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"mappingAttributeValue": "TestAPP1_APPID",
"mappingAttribute": "name",
"tenantName": "tenant1",
"type": "App",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
],
"groups": [
{
"display": "OPCAPP1.Administrator for OPCApp1",
"value": "e75096b138cb407ebe018c69fdd55fa0",
"type": "direct",
"$ref": "https://tenant-base-url/admin/v1/IDSGroups/e75096b138cb407ebe018c69fdd55fa0"
}
],
"appRoles": [
{
"value": "e75096b138cb407ebe018c69fdd55fa0",
"$ref": "https://tenant-base-url/admin/v1/AppRoles/e75096b138cb407ebe018c69fdd55fa0",
"appId": "5744effc0d50468fbe2b60bad84e4234",
"display": "Administrator for OPCApp1",
"type": "direct",
"appName": "OPCAPP1_APPID",
"adminRole": true,
"legacyGroupName": "OPCAPP1.Administrator for OPCApp1"
}
]
}
Example Request Body
The following example shows the contents of a request body in JSON format for an app that is disabled:
{
"mappingAttributeValue": "STORAGE27_APPID",
"password": "Password123",
"schemas": [
"urn:ietf:params:scim:schemas:oracle:idcs:PasswordAuthenticator"
]
}
Example Response Body
The following example shows the contents of the disabled app response body in JSON format:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
],
"detail": "APP_DISABLE_RESPONSE",
"status": "400",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error": {
"messageId": "APP_DISABLE_RESPONSE"
}
}