Replace an Identity Provider
put
/admin/v1/IdentityProviders/{id}
Request
Supported Media Types
- application/scim+json
- application/json
Path Parameters
-
id: string
ID of the resource
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.
Replace the current instance of IdentityProvider with provided payload.
Before you specify an attribute-value in a request to replace 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 : IdentityProvider
Type:
object
Federation trusted partner Identity Provider
Show Source
-
assertionAttribute(optional):
string
Maximum Length:
256
Deprecated Since: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
- idcsValuePersistedInOtherAttribute: true
-
authnRequestBinding(optional):
string
Allowed Values:
[ "Redirect", "Post" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
correlationPolicy(optional):
object correlationPolicy
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: complex
- uniqueness: none
-
deleteInProgress(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
description(optional):
string
Maximum Length:
250
SCIM++ Properties:- caseExact: false
- 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
-
enabled:
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
encryptionCertificate(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
iconUrl(optional):
string
Minimum Length:
1
Maximum Length:256
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
id(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: global
-
idcsCreatedBy:
object idcsCreatedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
idcsLastModifiedBy(optional):
object idcsLastModifiedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
idcsLastUpgradedInRelease(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
idcsPreventedOperations(optional):
array idcsPreventedOperations
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
idpSsoUrl(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
includeSigningCertInSignature(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvAssignedGroups(optional):
array jitUserProvAssignedGroups
Added In: 20.1.3
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
jitUserProvAttributes(optional):
object jitUserProvAttributes
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: false
- mutability: immutable
- required: false
- returned: default
- type: complex
- uniqueness: none
-
jitUserProvAttributeUpdateEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvCreateUserEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvGroupAssertionAttributeEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvGroupAssignmentMethod(optional):
string
Maximum Length:
10
Allowed Values:[ "Overwrite", "Merge" ]
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
jitUserProvGroupSAMLAttributeName(optional):
string
Maximum Length:
256
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
jitUserProvGroupStaticListEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
logoutBinding(optional):
string
Allowed Values:
[ "Redirect", "Post" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
logoutEnabled(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
logoutRequestUrl(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
logoutResponseUrl(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- 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
-
metadata(optional):
string
Maximum Length:
100000
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
nameIdFormat(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- 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
-
partnerName:
string
Maximum Length:
100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: server
-
partnerProviderId(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: server
-
requestedAuthenticationContext(optional):
array requestedAuthenticationContext
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
requireForceAuthn(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
requiresEncryptedAssertion(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
samlHoKRequired(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
schemas:
array schemas
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
serviceInstanceIdentifier(optional):
string
Added In: 18.2.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: string
- uniqueness: server
-
shownOnLoginPage(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
signatureHashAlgorithm(optional):
string
Allowed Values:
[ "SHA-1", "SHA-256" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
signingCertificate(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
succinctId(optional):
string
Maximum Length:
100
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: server
-
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
-
tenantProviderId(optional):
string
Maximum Length:
256
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Minimum Length:
1
Maximum Length:20
Allowed Values:[ "SAML", "SOCIAL", "IWA", "X509", "LOCAL" ]
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: always
- type: string
- uniqueness: none
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:social:IdentityProvider(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:social:IdentityProvider
Social Identity Provider Extension Schema
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider
X509 Identity Provider Extension Schema
-
userMappingMethod(optional):
string
Allowed Values:
[ "NameIDToUserAttribute", "AssertionAttributeToUserAttribute", "CorrelationPolicyRule" ]
Deprecated Since: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
- idcsValuePersistedInOtherAttribute: true
-
userMappingStoreAttribute(optional):
string
Maximum Length:
256
Deprecated Since: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
- idcsValuePersistedInOtherAttribute: true
You can construct the userMappingStoreAttribute value by specifying attributes from the OCI IAM Core Users schema. For examples of how to construct the userMappingStoreAttribute value, see the Example of a Request Body section of the Examples tab for the POST and PUT methods of the /IdentityProviders endpoint.
Nested Schema : correlationPolicy
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- 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
-
type:
string
Maximum Length:
40
Allowed Values:[ "Policy" ]
Added In: 20.1.3
SCIM++ Properties:- idcsDefaultValue: Policy
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsCreatedBy
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsLastModifiedBy
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsPreventedOperations
Type:
array
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"replace",
"update",
"delete"
]
Nested Schema : jitUserProvAssignedGroups
Type:
array
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object jitUserProvAssignedGroups
Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.
Nested Schema : jitUserProvAttributes
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: false
- mutability: immutable
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- mutability: immutable
- required: false
- returned: default
- type: reference
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- mutability: immutable
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : meta
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
- type: complex
-
created(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
lastModified(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
location(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
resourceType(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
version(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : requestedAuthenticationContext
Type:
array
Maximum Length:
1000
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : schemas
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider
Type:
object
X509 Identity Provider Extension Schema
Show Source
-
certMatchAttribute:
string
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
crlCheckOnOCSPFailureEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
crlEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
crlLocation(optional):
string
Maximum Length:
1000
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
crlReloadDuration(optional):
integer
Added In: 2010242156
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
ocspAllowUnknownResponseStatus(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspEnableSignedResponse(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspResponderURL(optional):
string
Maximum Length:
1000
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocspRevalidateTime(optional):
integer
Added In: 2010242156
SCIM++ Properties:- idcsMaxValue: 24
- idcsMinValue: 0
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
ocspServerName(optional):
string
Maximum Length:
100
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocspTrustCertChain(optional):
array ocspTrustCertChain
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
otherCertMatchAttribute(optional):
string
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
signingCertificateChain:
array signingCertificateChain
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
userMatchAttribute:
string
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : jitUserProvAssignedGroups
Type:
object
Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.
Show Source
-
$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
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : ocspTrustCertChain
Type:
array
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : signingCertificateChain
Type:
array
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Response
Supported Media Types
- application/json
- application/scim+json
200 Response
The request was successful. We replaced the resource.
Root Schema : IdentityProvider
Type:
object
Federation trusted partner Identity Provider
Show Source
-
assertionAttribute(optional):
string
Maximum Length:
256
Deprecated Since: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
- idcsValuePersistedInOtherAttribute: true
-
authnRequestBinding(optional):
string
Allowed Values:
[ "Redirect", "Post" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
compartmentOcid(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
correlationPolicy(optional):
object correlationPolicy
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- type: complex
- uniqueness: none
-
deleteInProgress(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
description(optional):
string
Maximum Length:
250
SCIM++ Properties:- caseExact: false
- 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
-
enabled:
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: boolean
- uniqueness: none
-
encryptionCertificate(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
externalId(optional):
string
SCIM++ Properties:
- caseExact: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
iconUrl(optional):
string
Minimum Length:
1
Maximum Length:256
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
id(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: always
- type: string
- uniqueness: global
-
idcsCreatedBy:
object idcsCreatedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
idcsLastModifiedBy(optional):
object idcsLastModifiedBy
SCIM++ Properties:
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
idcsLastUpgradedInRelease(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
idcsPreventedOperations(optional):
array idcsPreventedOperations
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
-
idpSsoUrl(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
includeSigningCertInSignature(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvAssignedGroups(optional):
array jitUserProvAssignedGroups
Added In: 20.1.3
SCIM++ Properties:- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
jitUserProvAttributes(optional):
object jitUserProvAttributes
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: false
- mutability: immutable
- required: false
- returned: default
- type: complex
- uniqueness: none
-
jitUserProvAttributeUpdateEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvCreateUserEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvGroupAssertionAttributeEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
jitUserProvGroupAssignmentMethod(optional):
string
Maximum Length:
10
Allowed Values:[ "Overwrite", "Merge" ]
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
jitUserProvGroupSAMLAttributeName(optional):
string
Maximum Length:
256
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
jitUserProvGroupStaticListEnabled(optional):
boolean
Added In: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
logoutBinding(optional):
string
Allowed Values:
[ "Redirect", "Post" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
logoutEnabled(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
logoutRequestUrl(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
logoutResponseUrl(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- 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
-
metadata(optional):
string
Maximum Length:
100000
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
nameIdFormat(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- 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
-
partnerName:
string
Maximum Length:
100
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: always
- type: string
- uniqueness: server
-
partnerProviderId(optional):
string
Maximum Length:
256
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: server
-
requestedAuthenticationContext(optional):
array requestedAuthenticationContext
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
requireForceAuthn(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
requiresEncryptedAssertion(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
samlHoKRequired(optional):
boolean
Added In: 2102181953
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
schemas:
array schemas
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
serviceInstanceIdentifier(optional):
string
Added In: 18.2.6
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: never
- type: string
- uniqueness: server
-
shownOnLoginPage(optional):
boolean
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
signatureHashAlgorithm(optional):
string
Allowed Values:
[ "SHA-1", "SHA-256" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
signingCertificate(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
succinctId(optional):
string
Maximum Length:
100
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: server
-
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
-
tenantProviderId(optional):
string
Maximum Length:
256
Added In: 19.2.1
SCIM++ Properties:- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Minimum Length:
1
Maximum Length:20
Allowed Values:[ "SAML", "SOCIAL", "IWA", "X509", "LOCAL" ]
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: immutable
- required: false
- returned: always
- type: string
- uniqueness: none
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:social:IdentityProvider(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:social:IdentityProvider
Social Identity Provider Extension Schema
-
urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider(optional):
object urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider
X509 Identity Provider Extension Schema
-
userMappingMethod(optional):
string
Allowed Values:
[ "NameIDToUserAttribute", "AssertionAttributeToUserAttribute", "CorrelationPolicyRule" ]
Deprecated Since: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
- idcsValuePersistedInOtherAttribute: true
-
userMappingStoreAttribute(optional):
string
Maximum Length:
256
Deprecated Since: 20.1.3
SCIM++ Properties:- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
- idcsValuePersistedInOtherAttribute: true
You can construct the userMappingStoreAttribute value by specifying attributes from the OCI IAM Core Users schema. For examples of how to construct the userMappingStoreAttribute value, see the Example of a Request Body section of the Examples tab for the POST and PUT methods of the /IdentityProviders endpoint.
Nested Schema : correlationPolicy
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: false
- returned: default
- 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
-
type:
string
Maximum Length:
40
Allowed Values:[ "Policy" ]
Added In: 20.1.3
SCIM++ Properties:- idcsDefaultValue: Policy
- idcsSearchable: false
- multiValued: false
- mutability: immutable
- required: true
- returned: default
- type: string
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsCreatedBy
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsLastModifiedBy
Type:
object
SCIM++ Properties:
Show Source
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: complex
-
$ref(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: reference
- uniqueness: none
-
display(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocid(optional):
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- returned: default
- type: string
- uniqueness: none
-
type(optional):
string
Allowed Values:
[ "User", "App" ]
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
value:
string
SCIM++ Properties:
- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : idcsPreventedOperations
Type:
array
SCIM++ Properties:
- idcsSearchable: false
- multiValued: true
- mutability: readOnly
- required: false
- returned: request
- type: string
- uniqueness: none
Allowed Values:
Show Source
[
"replace",
"update",
"delete"
]
Nested Schema : jitUserProvAssignedGroups
Type:
array
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- idcsCompositeKey: [value]
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: complex
- uniqueness: none
-
Array of:
object jitUserProvAssignedGroups
Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.
Nested Schema : jitUserProvAttributes
Type:
object
Added In: 20.1.3
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsCompositeKey: [value]
- idcsSearchable: false
- mutability: immutable
- required: false
- returned: default
- type: complex
- uniqueness: none
-
$ref(optional):
string
Added In: 20.1.3
SCIM++ Properties:- idcsSearchable: false
- mutability: immutable
- required: false
- returned: default
- type: reference
- uniqueness: none
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- mutability: immutable
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : meta
Type:
object
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- idcsCsvAttributeNameMappings: [[columnHeaderName:Created Date, mapsTo:meta.created]]
- type: complex
-
created(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
lastModified(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: true
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: dateTime
- uniqueness: none
-
location(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
resourceType(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
-
version(optional):
string
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readOnly
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : requestedAuthenticationContext
Type:
array
Maximum Length:
1000
Added In: 2102181953
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: true
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : schemas
Type:
array
SCIM++ Properties:
Show Source
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : urn:ietf:params:scim:schemas:oracle:idcs:extension:x509:IdentityProvider
Type:
object
X509 Identity Provider Extension Schema
Show Source
-
certMatchAttribute:
string
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
crlCheckOnOCSPFailureEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
crlEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
crlLocation(optional):
string
Maximum Length:
1000
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
crlReloadDuration(optional):
integer
Added In: 2010242156
SCIM++ Properties:- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
ocspAllowUnknownResponseStatus(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspEnabled(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspEnableSignedResponse(optional):
boolean
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: boolean
- uniqueness: none
-
ocspResponderURL(optional):
string
Maximum Length:
1000
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocspRevalidateTime(optional):
integer
Added In: 2010242156
SCIM++ Properties:- idcsMaxValue: 24
- idcsMinValue: 0
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: integer
- uniqueness: none
-
ocspServerName(optional):
string
Maximum Length:
100
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
ocspTrustCertChain(optional):
array ocspTrustCertChain
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
otherCertMatchAttribute(optional):
string
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
-
signingCertificateChain:
array signingCertificateChain
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
-
userMatchAttribute:
string
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:- caseExact: false
- idcsSearchable: false
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : jitUserProvAssignedGroups
Type:
object
Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.
Show Source
-
$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
-
value:
string
Minimum Length:
1
Maximum Length:40
Added In: 20.1.3
SCIM++ Properties:- caseExact: true
- idcsSearchable: true
- multiValued: false
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
Nested Schema : ocspTrustCertChain
Type:
array
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: false
- returned: default
- type: string
- uniqueness: none
Nested Schema : signingCertificateChain
Type:
array
Maximum Length:
256
Added In: 2010242156
SCIM++ Properties:
Show Source
SCIM++ Properties:
- caseExact: false
- idcsSearchable: false
- multiValued: true
- mutability: readWrite
- required: true
- returned: default
- type: string
- uniqueness: none
400 Response
Bad or invalid request
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
401 Response
The supplied credentials, if any, are not sufficient to access the resource.
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
404 Response
The requested resource could not be found.
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
500 Response
We couldn't return the representation due to an internal server error.
Root Schema : Error
Type:
object
The SCIM Protocol uses the HTTP status response status codes defined
in Section 6 [RFC7231] to indicate operation success or failure.
In addition to returning a HTTP response code implementers MUST return
the errors in the body of the response in the client requested format
containing the error response and, per the HTTP specification, human-
readable explanations.
Show Source
-
detail(optional):
string
A detailed, human readable message. OPTIONAL
-
schemas:
array schemas
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
-
status:
string
The HTTP status code (see Section 6 [RFC7231]) expressed as a JSON String
-
urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error(optional):
object urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : schemas
Type:
array
The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for SCIM specified Error and Extn Error Schema. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.
Allowed Values:
Show Source
[
"urn:ietf:params:scim:api:messages:2.0:Error",
"urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error"
]
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type:
object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Show Source
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
-
additionalData(optional):
object additionalData
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
-
messageId(optional):
string
Internal error keyword pointing to the exception status message. REQUIRED.
Nested Schema : additionalData
Type:
object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.