Update User Info
patch
/admin/v1/Me
Request
Supported Media Types
- application/scim+json
- 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.
-
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.
Update the Me with SCIM Patch schema.
Before you specify an attribute-value in a request to update 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.
Root Schema : PatchOp
Type:
object
See Section 3.5.2. HTTP PATCH is an OPTIONAL server function that enables clients to update one or more attributes of a SCIM resource using a sequence of operations to "add", "remove", or "replace" values. Clients may discover service provider support for PATCH by querying the service provider configuration. The general form of the SCIM patch request is based on JavaScript Object Notation (JSON) Patch [RFC6902]. One difference between SCIM patch and JSON patch is that SCIM servers do not support array indexing and do not support [RFC6902] operation types relating to array element manipulation such as "move". A patch request, regardless of the number of operations, SHALL be treated as atomic. If a single operation encounters an error condition, the original SCIM resource MUST be restored, and a failure status SHALL be returned.
Show Source
-
Operations:
array Operations
The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
-
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.
Nested Schema : Operations
Type:
array
The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
Show Source
-
Array of:
object Operations
Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See Section 3.5.2 for details.
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:PatchOp"
]
Nested Schema : Operations
Type:
object
Each patch operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace". See Section 3.5.2 for details.
Show Source
-
op:
string
Allowed Values:
[ "add", "remove", "replace" ]
Defines the operation to be performed for this Patch. If op=remove, value is not required. -
path:
string
String containing an attribute path describing the target of the operation. The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations. See Section 3.5.2 for details
-
value(optional):
string
The value could be either a simple value attribute e.g. string or number OR complex like map of the attributes to be added or replaced OR multivalues complex attributes.q1
Response
Supported Media Types
- application/json
- application/scim+json
200 Response
The request was successful. We updated the resource.
Root Schema : Me
Type:
object
User Account
Show Source
-
active(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsCsvAttributeName: Active
- idcsCsvAttributeNameMappings: [[columnHeaderName:Active]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
addresses(optional):
array addresses
SCIM++ Properties:
- idcsCompositeKey: [type]
- idcsCsvAttributeNameMappings: [[columnHeaderName:Work Address Street, deprecatedColumnHeaderName:Work Street Address, mapsTo:addresses[work].streetAddress], [columnHeaderName:Work Address Locality, deprecatedColumnHeaderName:Work City, mapsTo:addresses[work].locality], [columnHeaderName:Work Address Region, deprecatedColumnHeaderName:Work State, mapsTo:addresses[work].region], [columnHeaderName:Work Address Postal Code, deprecatedColumnHeaderName:Work Postal Code, mapsTo:addresses[work].postalCode], [columnHeaderName:Work Address Country, deprecatedColumnHeaderName:Work Country, mapsTo:addresses[work].country], [columnHeaderName:Work Address Formatted, mapsTo:addresses[work].formatted], [columnHeaderName:Home Address Formatted, mapsTo:addresses[home].formatted], [columnHeaderName:Other Address Formatted, mapsTo:addresses[other].formatted], [columnHeaderName:Home Address Street, mapsTo:addresses[home].streetAddress], [columnHeaderName:Other Address Street, mapsTo:addresses[other].streetAddress], [columnHeaderName:Home Address Locality, mapsTo:addresses[home].locality], [columnHeaderName:Other Address Locality, mapsTo:addresses[other].locality], [columnHeaderName:Home Address Region, mapsTo:addresses[home].region], [columnHeaderName:Other Address Region, mapsTo:addresses[other].region], [columnHeaderName:Home Address Country, mapsTo:addresses[home].country], [columnHeaderName:Other Address Country, mapsTo:addresses[other].country], [columnHeaderName:Home Address Postal Code, mapsTo:addresses[home].postalCode], [columnHeaderName:Other Address Postal Code, mapsTo:addresses[other].postalCode], [columnHeaderName:Primary Address Type, mapsTo:addresses[$(type)].primary]]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- 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
-
deleteInProgress(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
description(optional):
string
Minimum Length:
1
Maximum Length:400
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsPii: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
displayName(optional):
string
Minimum Length:
1
Maximum Length:382
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Display Name
- idcsCsvAttributeNameMappings: [[columnHeaderName:Display Name]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
domainOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
emails(optional):
array emails
SCIM++ Properties:
- idcsCompositeKey: [value, type]
- idcsCsvAttributeNameMappings: [[columnHeaderName:Work Email, mapsTo:emails[work].value], [columnHeaderName:Home Email, mapsTo:emails[home].value], [columnHeaderName:Primary Email Type, mapsTo:emails[$(type)].primary], [columnHeaderName:Other Email, mapsTo:emails[other].value], [columnHeaderName:Recovery Email, mapsTo:emails[recovery].value], [columnHeaderName:Work Email Verified, mapsTo:emails[work].verified], [columnHeaderName:Home Email Verified, mapsTo:emails[home].verified], [columnHeaderName:Other Email Verified, mapsTo:emails[other].verified], [columnHeaderName:Recovery Email Verified, mapsTo:emails[recovery].verified]]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
entitlements(optional):
array entitlements
SCIM++ Properties:
- idcsCompositeKey: [value, type]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsCsvAttributeNameMappings: [[columnHeaderName:External Id]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
groups(optional):
array groups
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- 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
-
ims(optional):
array ims
SCIM++ Properties:
- idcsCompositeKey: [value, type]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
locale(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Locale
- idcsCsvAttributeNameMappings: [[columnHeaderName:Locale]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- 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
-
name:
object name
SCIM++ Properties:
- idcsCsvAttributeNameMappings: [[columnHeaderName:Formatted Name, mapsTo:name.formatted], [columnHeaderName:Honorific Prefix, mapsTo:name.honorificPrefix], [columnHeaderName:First Name, mapsTo:name.givenName], [columnHeaderName:Middle Name, mapsTo:name.middleName], [columnHeaderName:Last Name, mapsTo:name.familyName], [columnHeaderName:Honorific Suffix, mapsTo:name.honorificSuffix]]
- idcsPii: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
nickName(optional):
string
Minimum Length:
5
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Nick Name
- idcsCsvAttributeNameMappings: [[columnHeaderName:Nick Name]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
Maximum Length:
255
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: string
- uniqueness: global
-
password(optional):
string
Minimum Length:
1
Maximum Length:500
SCIM++ Properties:- idcsCsvAttributeName: Password
- idcsCsvAttributeNameMappings: [[columnHeaderName:Password]]
- idcsPii: true
- idcsSearchable: false
- idcsSensitive: hash
- multiValued: false
- mutability: writeOnly
- required: false
- returned: never
- type: string
- uniqueness: none
-
phoneNumbers(optional):
array phoneNumbers
SCIM++ Properties:
- idcsCompositeKey: [value, type]
- idcsCsvAttributeNameMappings: [[columnHeaderName:Work Phone, mapsTo:phoneNumbers[work].value], [columnHeaderName:Mobile No, mapsTo:phoneNumbers[mobile].value], [columnHeaderName:Home Phone, mapsTo:phoneNumbers[home].value], [columnHeaderName:Fax, mapsTo:phoneNumbers[fax].value], [columnHeaderName:Pager, mapsTo:phoneNumbers[pager].value], [columnHeaderName:Other Phone, mapsTo:phoneNumbers[other].value], [columnHeaderName:Recovery Phone, mapsTo:phoneNumbers[recovery].value], [columnHeaderName:Primary Phone Type, mapsTo:phoneNumbers[$(type)].primary]]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
photos(optional):
array photos
SCIM++ Properties:
- idcsCompositeKey: [value, type]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
preferredLanguage(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Preferred Language
- idcsCsvAttributeNameMappings: [[columnHeaderName:Preferred Language]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
profileUrl(optional):
string
Minimum Length:
1
Maximum Length:2000
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Profile URL
- idcsCsvAttributeNameMappings: [[columnHeaderName:Profile Url]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: reference
- uniqueness: none
-
roles(optional):
array roles
SCIM++ Properties:
- idcsCompositeKey: [value, type]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
schemas:
array schemas
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
tags(optional):
array tags
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
tenancyOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
timezone(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCanonicalValueSourceFilter: attrName eq "timezones" and attrValues.value eq "$(timezone)"
- idcsCanonicalValueSourceResourceType: AllowedValue
- idcsCsvAttributeName: TimeZone
- idcsCsvAttributeNameMappings: [[columnHeaderName:Time Zone, deprecatedColumnHeaderName:TimeZone]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
title(optional):
string
Minimum Length:
1
Maximum Length:200
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Title
- idcsCsvAttributeNameMappings: [[columnHeaderName:Title]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User(optional):
object urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
Enterprise User
-
urn:ietf:params:scim:schemas:idcs:extension:custom:User(optional):
object urn:ietf:params:scim:schemas:idcs:extension:custom:User
Custom User Attributes
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:capabilities:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:capabilities:User
User's Capabilities
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:crossSso:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:crossSso:User
This extension defines attributes to manage User account for Cross Tenant SSO.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:dbCredentials:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:dbCredentials:User
Db Credentials User extension
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:me:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:me:User
OCI IAM self service schema extension
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User
This extension defines attributes used to manage Multi-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags
OCI Tags.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User
This extension defines attributes used to manage account passwords within a Service Provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User
POSIX User extension
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User
This extension defines attributes used to store Security Questions of User.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User
This extension defines attributes used to manage self registration profile linked to the user.
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:termsOfUse:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:termsOfUse:User
Terms Of Use extension
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User
OCI IAM User
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:userCredentials:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:userCredentials:User
User's credentials
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User
This extension defines attributes used to manage account passwords within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords.
-
userName:
string
Minimum Length:
1
Maximum Length:256
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: User ID
- idcsCsvAttributeNameMappings: [[columnHeaderName:User Name, deprecatedColumnHeaderName:User ID]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: global
-
userType(optional):
string
Allowed Values:
[ "Contractor", "Employee", "Intern", "Temp", "External", "Service", "Generic" ]
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: User Type
- idcsCsvAttributeNameMappings: [[columnHeaderName:User Type]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
x509Certificates(optional):
array x509Certificates
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : addresses
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [type]
- idcsCsvAttributeNameMappings: [[columnHeaderName:Work Address Street, deprecatedColumnHeaderName:Work Street Address, mapsTo:addresses[work].streetAddress], [columnHeaderName:Work Address Locality, deprecatedColumnHeaderName:Work City, mapsTo:addresses[work].locality], [columnHeaderName:Work Address Region, deprecatedColumnHeaderName:Work State, mapsTo:addresses[work].region], [columnHeaderName:Work Address Postal Code, deprecatedColumnHeaderName:Work Postal Code, mapsTo:addresses[work].postalCode], [columnHeaderName:Work Address Country, deprecatedColumnHeaderName:Work Country, mapsTo:addresses[work].country], [columnHeaderName:Work Address Formatted, mapsTo:addresses[work].formatted], [columnHeaderName:Home Address Formatted, mapsTo:addresses[home].formatted], [columnHeaderName:Other Address Formatted, mapsTo:addresses[other].formatted], [columnHeaderName:Home Address Street, mapsTo:addresses[home].streetAddress], [columnHeaderName:Other Address Street, mapsTo:addresses[other].streetAddress], [columnHeaderName:Home Address Locality, mapsTo:addresses[home].locality], [columnHeaderName:Other Address Locality, mapsTo:addresses[other].locality], [columnHeaderName:Home Address Region, mapsTo:addresses[home].region], [columnHeaderName:Other Address Region, mapsTo:addresses[other].region], [columnHeaderName:Home Address Country, mapsTo:addresses[home].country], [columnHeaderName:Other Address Country, mapsTo:addresses[other].country], [columnHeaderName:Home Address Postal Code, mapsTo:addresses[home].postalCode], [columnHeaderName:Other Address Postal Code, mapsTo:addresses[other].postalCode], [columnHeaderName:Primary Address Type, mapsTo:addresses[$(type)].primary]]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object addresses
A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.
Nested Schema : emails
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value, type]
- idcsCsvAttributeNameMappings: [[columnHeaderName:Work Email, mapsTo:emails[work].value], [columnHeaderName:Home Email, mapsTo:emails[home].value], [columnHeaderName:Primary Email Type, mapsTo:emails[$(type)].primary], [columnHeaderName:Other Email, mapsTo:emails[other].value], [columnHeaderName:Recovery Email, mapsTo:emails[recovery].value], [columnHeaderName:Work Email Verified, mapsTo:emails[work].verified], [columnHeaderName:Home Email Verified, mapsTo:emails[home].verified], [columnHeaderName:Other Email Verified, mapsTo:emails[other].verified], [columnHeaderName:Recovery Email Verified, mapsTo:emails[recovery].verified]]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object emails
A complex attribute representing emails
Nested Schema : entitlements
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value, type]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object entitlements
A list of entitlements for the User that represent a thing the User has.
Nested Schema : groups
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object groups
A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated
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 : ims
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value, type]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object ims
User's instant messaging addresses
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 : name
Type:
object
SCIM++ Properties:
Show Source
- idcsCsvAttributeNameMappings: [[columnHeaderName:Formatted Name, mapsTo:name.formatted], [columnHeaderName:Honorific Prefix, mapsTo:name.honorificPrefix], [columnHeaderName:First Name, mapsTo:name.givenName], [columnHeaderName:Middle Name, mapsTo:name.middleName], [columnHeaderName:Last Name, mapsTo:name.familyName], [columnHeaderName:Honorific Suffix, mapsTo:name.honorificSuffix]]
- idcsPii: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: complex
- uniqueness: none
-
familyName:
string
Minimum Length:
1
Maximum Length:150
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Last Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
formatted(optional):
string
Minimum Length:
1
Maximum Length:354
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
givenName(optional):
string
Minimum Length:
1
Maximum Length:150
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: First Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
honorificPrefix(optional):
string
Minimum Length:
1
Maximum Length:25
SCIM++ Properties:- idcsCsvAttributeName: Honorific Prefix
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
honorificSuffix(optional):
string
Minimum Length:
1
Maximum Length:25
SCIM++ Properties:- idcsCsvAttributeName: Honorific Suffix
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
middleName(optional):
string
Maximum Length:
100
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Middle Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : phoneNumbers
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value, type]
- idcsCsvAttributeNameMappings: [[columnHeaderName:Work Phone, mapsTo:phoneNumbers[work].value], [columnHeaderName:Mobile No, mapsTo:phoneNumbers[mobile].value], [columnHeaderName:Home Phone, mapsTo:phoneNumbers[home].value], [columnHeaderName:Fax, mapsTo:phoneNumbers[fax].value], [columnHeaderName:Pager, mapsTo:phoneNumbers[pager].value], [columnHeaderName:Other Phone, mapsTo:phoneNumbers[other].value], [columnHeaderName:Recovery Phone, mapsTo:phoneNumbers[recovery].value], [columnHeaderName:Primary Phone Type, mapsTo:phoneNumbers[$(type)].primary]]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object phoneNumbers
Phone numbers
Nested Schema : photos
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value, type]
- idcsPii: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object photos
URLs of photos for the User
Nested Schema : roles
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value, type]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object roles
A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'.
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 : urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
Type:
object
Enterprise User
Show Source
-
costCenter(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Cost Center
- idcsCsvAttributeNameMappings: [[columnHeaderName:Cost Center]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
department(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Department
- idcsCsvAttributeNameMappings: [[columnHeaderName:Department]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
division(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Division
- idcsCsvAttributeNameMappings: [[columnHeaderName:Division]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
employeeNumber(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Employee Number
- idcsCsvAttributeNameMappings: [[columnHeaderName:Employee Number]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
manager(optional):
object manager
SCIM++ Properties:
- idcsCsvAttributeNameMappings: [[columnHeaderName:Manager, deprecatedColumnHeaderName:Manager Name, mapsTo:manager.value]]
- idcsPii: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
organization(optional):
string
Minimum Length:
1
Maximum Length:50
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeName: Organization
- idcsCsvAttributeNameMappings: [[columnHeaderName:Organization Name, deprecatedColumnHeaderName:Organization]]
- idcsPii: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:idcs:extension:custom:User
Type:
object
Custom User Attributes
Show Source
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:capabilities:User
Type:
object
User's Capabilities
Show Source
-
canUseApiKeys(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
canUseAuthTokens(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
canUseConsolePassword(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
canUseCustomerSecretKeys(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
canUseDbCredentials(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
canUseOAuth2ClientCredentials(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
canUseSmtpCredentials(optional):
boolean
Added In: 2012271618
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:crossSso:User
Type:
object
This extension defines attributes to manage User account for Cross Tenant SSO.
Show Source
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:dbCredentials:User
Type:
object
Db Credentials User extension
Show Source
-
dbLoginAttempts(optional):
integer
Added In: 2102181953
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: integer
- uniqueness: none
-
dbPasswordHistory(optional):
array dbPasswordHistory
Added In: 2102181953
SCIM++ Properties:- idcsCompositeKey: [value, sequenceNumber]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: never
- type: complex
- uniqueness: none
-
dbUserName(optional):
string
Minimum Length:
1
Maximum Length:128
Added In: 2102181953
SCIM++ Properties:- multiValued: false
- mutability: readWrite
- required: false
- type: string
- returned: request
- caseExact: false
- uniqueness: none
- idcsSearchable: true
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:me:User
Type:
object
OCI IAM self service schema extension
Show Source
-
currentPassword(optional):
string
Minimum Length:
1
Maximum Length:500
SCIM++ Properties:- idcsSearchable: false
- idcsSensitive: hash
- multiValued: false
- mutability: writeOnly
- required: false
- returned: never
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:mfa:User
Type:
object
This extension defines attributes used to manage Multi-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA.
Show Source
-
bypassCodes(optional):
array bypassCodes
Added In: 18.3.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
devices(optional):
array devices
Added In: 18.3.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
loginAttempts(optional):
integer
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
- uniqueness: none
-
mfaEnabledOn(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
mfaIgnoredApps(optional):
array mfaIgnoredApps
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
mfaStatus(optional):
string
Allowed Values:
[ "ENROLLED", "IGNORED", "UN_ENROLLED", "DISABLED" ]
Added In: 18.3.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
preferredAuthenticationFactor(optional):
string
Minimum Length:
1
Maximum Length:40
Allowed Values:[ "EMAIL", "SMS", "TOTP", "PUSH", "OFFLINETOTP", "USERNAME_PASSWORD", "SECURITY_QUESTIONS", "VOICE", "PHONE_CALL", "THIRDPARTY", "FIDO_AUTHENTICATOR", "YUBICO_OTP" ]
Added In: 18.3.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
preferredAuthenticationMethod(optional):
string
Maximum Length:
80
Added In: 2009232244
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
preferredDevice(optional):
object preferredDevice
Added In: 18.3.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
preferredThirdPartyVendor(optional):
string
Maximum Length:
50
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
trustedUserAgents(optional):
array trustedUserAgents
Added In: 18.3.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:OCITags
Type:
object
OCI Tags.
Show Source
-
definedTags(optional):
array definedTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
-
freeformTags(optional):
array freeformTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
-
tagSlug(optional):
object tagSlug
Added In: 2011192329
SCIM++ Properties:- type: binary
- mutability: readOnly
- returned: request
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:passwordState:User
Type:
object
This extension defines attributes used to manage account passwords within a Service Provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords.
Show Source
-
applicablePasswordPolicy(optional):
object applicablePasswordPolicy
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
cantChange(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
cantExpire(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
expired(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
lastFailedValidationDate(optional):
string
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
lastSuccessfulSetDate(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
lastSuccessfulValidationDate(optional):
string
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
mustChange(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:posix:User
Type:
object
POSIX User extension
Show Source
-
gecos(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: string
- uniqueness: none
-
gidNumber(optional):
integer
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: integer
- uniqueness: none
-
homeDirectory(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: string
- uniqueness: none
-
loginShell(optional):
string
SCIM++ Properties:
- caseExact: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: string
- uniqueness: none
-
uidNumber(optional):
integer
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: integer
- uniqueness: server
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:securityQuestions:User
Type:
object
This extension defines attributes used to store Security Questions of User.
Show Source
-
secQuestions(optional):
array secQuestions
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:selfRegistration:User
Type:
object
This extension defines attributes used to manage self registration profile linked to the user.
Show Source
-
consentGranted(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
selfRegistrationProfile:
object selfRegistrationProfile
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: true
- returned: request
- type: complex
- uniqueness: none
-
userToken(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:termsOfUse:User
Type:
object
Terms Of Use extension
Show Source
-
termsOfUseConsents(optional):
array termsOfUseConsents
Added In: 18.2.6
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:user:User
Type:
object
OCI IAM User
Show Source
-
accountRecoveryRequired(optional):
boolean
Added In: 19.1.4
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
accounts(optional):
array accounts
SCIM++ Properties:
- idcsPii: true
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
applicableAuthenticationTargetApp(optional):
object applicableAuthenticationTargetApp
Added In: 18.1.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
appRoles(optional):
array appRoles
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
bypassNotification(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsCsvAttributeNameMappings: [[columnHeaderName:ByPass Notification]]
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
creationMechanism(optional):
string
Allowed Values:
[ "bulk", "api", "adsync", "idcsui", "import", "authsync", "selfreg", "samljit" ]
SCIM++ Properties:- caseExact: false
- idcsCsvAttributeNameMappings: [[defaultValue:import]]
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: request
- type: string
- uniqueness: none
-
delegatedAuthenticationTargetApp(optional):
object delegatedAuthenticationTargetApp
Added In: 17.4.6
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
doNotShowGettingStarted(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
grants(optional):
array grants
SCIM++ Properties:
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
idcsAppRolesLimitedToGroups(optional):
array idcsAppRolesLimitedToGroups
Added In: 19.2.1
SCIM++ Properties:- idcsCompositeKey: [value, idcsAppRoleId]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
isAccountRecoveryEnrolled(optional):
boolean
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
isAuthenticationDelegated(optional):
boolean
Added In: 17.4.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
isFederatedUser(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsCsvAttributeName: Federated
- idcsCsvAttributeNameMappings: [[columnHeaderName:Federated]]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
isGroupMembershipNormalized(optional):
boolean
Deprecated Since: 19.3.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
isGroupMembershipSyncedToUsersGroups(optional):
boolean
Added In: 19.3.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
notificationEmailTemplateId(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: writeOnly
- required: false
- returned: never
- type: string
- uniqueness: none
-
provider(optional):
string
Allowed Values:
[ "facebook", "google", "IDCS", "twitter" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: string
- uniqueness: none
-
status(optional):
string
Allowed Values:
[ "pendingVerification", "verified" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
supportAccounts(optional):
array supportAccounts
Added In: 2103141444
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
syncedFromApp(optional):
object syncedFromApp
Added In: 18.2.6
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
- uniqueness: none
-
userFlowControlledByExternalClient(optional):
boolean
Added In: 18.4.2
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: never
- type: boolean
- uniqueness: none
-
userToken(optional):
object userToken
Added In: 18.4.2
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:userCredentials:User
Type:
object
User's credentials
Show Source
-
apiKeys(optional):
array apiKeys
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
authTokens(optional):
array authTokens
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
customerSecretKeys(optional):
array customerSecretKeys
Added In: 2102181953
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
dbCredentials(optional):
array dbCredentials
Added In: 2102181953
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
oAuth2ClientCredentials(optional):
array oAuth2ClientCredentials
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
smtpCredentials(optional):
array smtpCredentials
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:userState:User
Type:
object
This extension defines attributes used to manage account passwords within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords.
Show Source
-
lastFailedLoginDate(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- idcsAllowUpdatesInReadOnlyMode: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
lastSuccessfulLoginDate(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- idcsAllowUpdatesInReadOnlyMode: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
locked(optional):
object locked
SCIM++ Properties:
- idcsCsvAttributeNameMappings: [[columnHeaderName:Locked, mapsTo:locked.on], [columnHeaderName:Locked Reason, mapsTo:locked.reason], [columnHeaderName:Locked Date, mapsTo:locked.lockDate]]
- idcsSearchable: false
- idcsAllowUpdatesInReadOnlyMode: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
loginAttempts(optional):
integer
SCIM++ Properties:
- idcsSearchable: false
- idcsAllowUpdatesInReadOnlyMode: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: integer
- uniqueness: none
-
maxConcurrentSessions(optional):
integer
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsMaxValue: 999
- idcsMinValue: 1
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
previousSuccessfulLoginDate(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: dateTime
- uniqueness: none
-
recoveryAttempts(optional):
integer
Added In: 19.1.4
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: integer
- uniqueness: none
-
recoveryEnrollAttempts(optional):
integer
Added In: 19.1.4
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: integer
- uniqueness: none
-
recoveryLocked(optional):
object recoveryLocked
Added In: 19.1.4
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
Nested Schema : x509Certificates
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object x509Certificates
A list of certificates issued to the User.
Nested Schema : addresses
Type:
object
A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.
Show Source
-
country(optional):
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsCanonicalValueSourceFilter: attrName eq "countries" and attrValues.value eq "upper($(country))"
- idcsCanonicalValueSourceResourceType: AllowedValue
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
formatted(optional):
string
Minimum Length:
1
Maximum Length:4000
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
locality(optional):
string
Minimum Length:
1
Maximum Length:128
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
postalCode(optional):
string
Maximum Length:
50
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
region(optional):
string
Minimum Length:
1
Maximum Length:128
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
streetAddress(optional):
string
Minimum Length:
1
Maximum Length:1024
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
Allowed Values:
[ "work", "home", "other" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : emails
Type:
object
A complex attribute representing emails
Show Source
-
pendingVerificationData(optional):
string
Maximum Length:
4000
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
secondary(optional):
boolean
Added In: 18.2.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type:
string
Allowed Values:
[ "work", "home", "other", "recovery" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
5
Maximum Length:256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
verified(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : entitlements
Type:
object
A list of entitlements for the User that represent a thing the User has.
Show Source
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type:
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : groups
Type:
object
A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated
Show Source
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
dateAdded(optional):
string
Added In: 2105200541
SCIM++ Properties:- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
externalId(optional):
string
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
membershipOcid(optional):
string
Added In: 2103141444
SCIM++ Properties:- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
nonUniqueDisplay(optional):
string
Added In: 2011192329
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "direct", "indirect" ]
SCIM++ Properties:- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : ims
Type:
object
User's instant messaging addresses
Show Source
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type:
string
Allowed Values:
[ "aim", "gtalk", "icq", "xmpp", "msn", "skype", "qq", "yahoo" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : phoneNumbers
Type:
object
Phone numbers
Show Source
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type:
string
Allowed Values:
[ "work", "home", "mobile", "fax", "pager", "other", "recovery" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
verified(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : photos
Type:
object
URLs of photos for the User
Show Source
-
display(optional):
string
Minimum Length:
1
Maximum Length:100
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type:
string
Allowed Values:
[ "photo", "thumbnail" ]
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:2000
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: reference
- uniqueness: none
Nested Schema : roles
Type:
object
A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'.
Show Source
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type:
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Maximum Length:
100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : manager
Type:
object
SCIM++ Properties:
Show Source
- idcsCsvAttributeNameMappings: [[columnHeaderName:Manager, deprecatedColumnHeaderName:Manager Name, mapsTo:manager.value]]
- idcsPii: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
displayName(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
Minimum Length:
1
Maximum Length:40
SCIM++ Properties:- idcsCsvAttributeName: Manager Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : dbPasswordHistory
Type:
array
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value, sequenceNumber]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: never
- type: complex
- uniqueness: none
-
Array of:
object dbPasswordHistory
Added In: 2102181953
SCIM++ Properties:- idcsCompositeKey: [value, sequenceNumber]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: never
- type: complex
- uniqueness: none
Nested Schema : dbPasswordHistory
Type:
object
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value, sequenceNumber]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: never
- type: complex
- uniqueness: none
Nested Schema : bypassCodes
Type:
array
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object bypassCodes
Added In: 18.3.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : devices
Type:
array
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object devices
Added In: 18.3.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : mfaIgnoredApps
Type:
array
Minimum Length:
1
Maximum Length:
40
Added In: 19.2.1
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : preferredDevice
Type:
object
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 18.3.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 18.3.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : trustedUserAgents
Type:
array
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object trustedUserAgents
Added In: 18.3.6
SCIM++ Properties:- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : bypassCodes
Type:
object
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
value:
string
Added In: 18.3.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : devices
Type:
object
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
authenticationMethod(optional):
string
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
display(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
factorStatus(optional):
string
Added In: 18.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
factorType(optional):
string
Added In: 18.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
lastSyncTime(optional):
string
Added In: 18.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
status(optional):
string
Added In: 18.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
thirdPartyVendorName(optional):
string
Added In: 2009232244
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
Added In: 18.3.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : trustedUserAgents
Type:
object
Added In: 18.3.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 18.3.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 18.3.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : definedTags
Type:
array
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
-
Array of:
object definedTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
Nested Schema : freeformTags
Type:
array
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
-
Array of:
object freeformTags
Added In: 2011192329
SCIM++ Properties:- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
Nested Schema : tagSlug
Type:
object
Maximum Length:
4001
Added In: 2011192329
SCIM++ Properties:
SCIM++ Properties:
- type: binary
- mutability: readOnly
- returned: request
Nested Schema : definedTags
Type:
object
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [namespace, key, value]
- type: complex
- idcsSearchable: true
- required: false
- mutability: readWrite
- multiValued: true
- returned: default
-
key:
string
Maximum Length:
100
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- type: string
- required: true
- mutability: readWrite
- returned: default
- idcsSearchable: true
- uniqueness: none
-
namespace:
string
Maximum Length:
100
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- type: string
- required: true
- mutability: readWrite
- returned: default
- idcsSearchable: true
- uniqueness: none
-
value:
string
Maximum Length:
256
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- required: true
- mutability: readWrite
- returned: default
- type: string
- idcsSearchable: true
- uniqueness: none
Nested Schema : freeformTags
Type:
object
Added In: 2011192329
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [key, value]
- idcsSearchable: true
- type: complex
- required: false
- mutability: readWrite
- returned: default
- multiValued: true
-
key:
string
Maximum Length:
100
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- type: string
- required: true
- mutability: readWrite
- returned: default
- idcsSearchable: true
- uniqueness: none
-
value:
string
Maximum Length:
256
Added In: 2011192329
SCIM++ Properties:- caseExact: false
- required: true
- mutability: readWrite
- returned: default
- type: string
- idcsSearchable: true
- uniqueness: none
Nested Schema : applicablePasswordPolicy
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
priority(optional):
integer
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
- uniqueness: none
-
value:
string
Maximum Length:
40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : secQuestions
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object secQuestions
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : secQuestions
Type:
object
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
answer:
string
Minimum Length:
1
SCIM++ Properties:- idcsCsvAttributeName: Answer
- idcsSearchable: false
- idcsSensitive: hash
- multiValued: false
- mutability: writeOnly
- required: true
- returned: never
- type: string
- uniqueness: none
- idcsPii: true
-
hintText(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : selfRegistrationProfile
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: true
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : termsOfUseConsents
Type:
array
Added In: 18.2.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object termsOfUseConsents
Added In: 18.2.6
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : termsOfUseConsents
Type:
object
Added In: 18.2.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readWrite
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.2.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
value:
string
Nested Schema : accounts
Type:
array
SCIM++ Properties:
Show Source
- idcsPii: true
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object accounts
Accounts of App
Nested Schema : applicableAuthenticationTargetApp
Type:
object
Added In: 18.1.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.1.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 18.1.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
targetRequestTimeout(optional):
integer
Added In: 18.2.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: integer
- uniqueness: none
-
type:
string
Added In: 18.1.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 18.1.6
SCIM++ Properties:- caseExact: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
Nested Schema : appRoles
Type:
array
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object appRoles
SCIM++ Properties:
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : delegatedAuthenticationTargetApp
Type:
object
Added In: 17.4.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 17.4.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 17.4.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
Maximum Length:
40
Allowed Values:[ "App", "IdentitySource" ]
Added In: 17.4.6
SCIM++ Properties:- idcsDefaultValue: IdentitySource
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 17.4.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : grants
Type:
array
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object grants
Grants assigned to the app
Nested Schema : idcsAppRolesLimitedToGroups
Type:
array
Added In: 19.2.1
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value, idcsAppRoleId]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
Array of:
object idcsAppRolesLimitedToGroups
Added In: 19.2.1
SCIM++ Properties:- idcsCompositeKey: [value, idcsAppRoleId]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
Nested Schema : supportAccounts
Type:
array
Added In: 2103141444
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object supportAccounts
Added In: 2103141444
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : syncedFromApp
Type:
object
Added In: 18.2.6
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.2.6
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 18.2.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type:
string
Maximum Length:
40
Allowed Values:[ "IdentitySource", "App", "IdentityProvider" ]
Added In: 18.2.6
SCIM++ Properties:- idcsDefaultValue: IdentitySource
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 18.2.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : userToken
Type:
object
Added In: 18.4.2
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 18.4.2
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
value(optional):
string
Added In: 18.4.2
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : accounts
Type:
object
Accounts of App
Show Source
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
active(optional):
boolean
Added In: 17.4.6
SCIM++ Properties:- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
name(optional):
string
Added In: 17.4.6
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ownerId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : appRoles
Type:
object
SCIM++ Properties:
Show Source
- idcsCompositeKey: [value]
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
adminRole(optional):
boolean
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
appId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
appName(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- 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", "implicit" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: always
- type: string
- uniqueness: none
Nested Schema : grants
Type:
object
Grants assigned to the app
Show Source
-
$ref(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
granteeId(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
granteeType(optional):
string
Allowed Values:
[ "User", "Group" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
grantMechanism(optional):
string
Allowed Values:
[ "IMPORT_APPROLE_MEMBERS", "ADMINISTRATOR_TO_USER", "ADMINISTRATOR_TO_GROUP", "SERVICE_MANAGER_TO_USER", "ADMINISTRATOR_TO_APP", "SERVICE_MANAGER_TO_APP", "OPC_INFRA_TO_APP", "GROUP_MEMBERSHIP" ]
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.
A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':
- 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.
- 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.
- 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.
-
value(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsAppRolesLimitedToGroups
Type:
object
Added In: 19.2.1
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value, idcsAppRoleId]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
-
$ref(optional):
string
Added In: 19.2.1
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
Added In: 19.2.1
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
idcsAppRoleId:
string
Minimum Length:
1
Maximum Length:40
Added In: 19.2.1
SCIM++ Properties:- idcsCsvAttributeName: IDCS AppRole Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 19.2.1
SCIM++ Properties:- idcsCsvAttributeName: Group Name
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : supportAccounts
Type:
object
Added In: 2103141444
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2103141444
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
ocid(optional):
string
Added In: 2103141444
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
provider(optional):
string
Added In: 2103141444
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
userId(optional):
string
Added In: 2103141444
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2103141444
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : apiKeys
Type:
array
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object apiKeys
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : authTokens
Type:
array
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object authTokens
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : customerSecretKeys
Type:
array
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object customerSecretKeys
Added In: 2102181953
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : dbCredentials
Type:
array
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object dbCredentials
Added In: 2102181953
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : oAuth2ClientCredentials
Type:
array
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object oAuth2ClientCredentials
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : smtpCredentials
Type:
array
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
Array of:
object smtpCredentials
Added In: 2012271618
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
Nested Schema : apiKeys
Type:
object
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2012271618
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
key(optional):
string
Added In: 2106240046
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
ocid(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : authTokens
Type:
object
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2012271618
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
ocid(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : customerSecretKeys
Type:
object
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2102181953
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
ocid(optional):
string
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : dbCredentials
Type:
object
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2102181953
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
ocid(optional):
string
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : oAuth2ClientCredentials
Type:
object
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2012271618
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
ocid(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : smtpCredentials
Type:
object
Added In: 2012271618
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: true
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 2012271618
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
ocid(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
-
value(optional):
string
Added In: 2012271618
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: none
Nested Schema : locked
Type:
object
SCIM++ Properties:
Show Source
- idcsCsvAttributeNameMappings: [[columnHeaderName:Locked, mapsTo:locked.on], [columnHeaderName:Locked Reason, mapsTo:locked.reason], [columnHeaderName:Locked Date, mapsTo:locked.lockDate]]
- idcsSearchable: false
- idcsAllowUpdatesInReadOnlyMode: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Is Password Expired(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: request
- type: boolean
- uniqueness: none
-
lockDate(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
on(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
reason(optional):
integer
Allowed Values:
[ "0", "1", "2", "3", "4", "5" ]
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
Nested Schema : recoveryLocked
Type:
object
Added In: 19.1.4
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
lockDate(optional):
string
Added In: 19.1.4
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
on(optional):
boolean
Added In: 19.1.4
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
Nested Schema : x509Certificates
Type:
object
A list of certificates issued to the User.
Show Source
-
display(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
primary(optional):
boolean
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
type(optional):
string
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
object value
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: binary
- uniqueness: none
Nested Schema : value
Type:
object
SCIM++ Properties:
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: binary
- 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 was not 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.