Replace a User
put
/iam/directory/oud/scim/v1/Users/{entryUUID}
Used to replace a User in the directory. The body contains the user with the details it needs to be replaced with and the response has the details after it has been modified.
Request
Supported Media Types
- application/scim+json
Path Parameters
-
entryUUID(required): string
entryUUID for the LDAP entry to be fetched.
User that needs to be created
Root Schema : POSTANDPUTRequest
Type:
Show Source
object
-
schemas(required):
array schemas
The Schemas to be included for the schema type.
-
urn:ietf:params:scim:schemas:core:2.0:User(required):
object Core User Properties
-
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
object Enterprise specific User Properties
-
urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User:
object Oracle specific User Properties
Nested Schema : Core User Properties
Type:
Show Source
object
-
addresses:
array addresses
SCIM SubAttributes:
- streetAddress
- formatted
- country
- postalCode
- locality
- region
-
displayName:
array displayName
Display name of the User.
-
emails:
array emails
email of that specific User.
-
name(required):
array name
SCIM SubAttributes:
- formatted
- givenName
- familyName
-
password:
array password
password of that specific User.
-
phoneNumbers:
array phoneNumbers
phoneNumbers of the specific User
-
photos:
array photos
jpeg for the particular User.
-
preferredLanguage:
array preferredLanguage
Preffered Language of that specific User.
-
title:
array title
title of that specific User.
-
userName(required):
array userName
CN (common name) of the entry
-
userType:
array userType
Type of that specific User.
-
x509Certificates:
array x509Certificates
The certificates for the particular User.
Nested Schema : Enterprise specific User Properties
Type:
Show Source
object
-
department:
array department
Department the User is part of.
-
employeeNumber:
array employeeNumber
employeeNumber of the User.
-
manager:
array manager
SCIM SubAttributes:
- managerId
- displayName
-
organization:
array organization
Organization the User is part of.
Nested Schema : Oracle specific User Properties
Type:
Show Source
object
-
businessCategory:
array businessCategory
Business Category of the User.
-
carLicense:
array carLicense
carLicense of the User.
-
description:
array description
Description of the User.
-
destinationIndicator:
array destinationIndicator
Destination Indicator of the User.
-
facsimileTelephoneNumber:
array facsimileTelephoneNumber
facsimileTelephoneNumber of the User.
-
homePhone:
array homePhone
Home Phone number of the User.
-
initials:
array initials
initials of the User.
-
internationaliSDNNumber:
array internationaliSDNNumber
internationaliSDNNumber of the User.
-
labeledURI:
array labeledURI
Uniform Resource Identifier with optional label.
-
mobile:
array mobile
Mobile of the User.
-
objectClass:
array objectClass
Objectclass(es) which this entry belongs to.
-
pager:
array pager
pager of the User.
-
physicalDeliveryOfficeName:
array physicalDeliveryOfficeName
Physical Delivery Office Name of the User.
-
postOfficeBox:
array postOfficeBox
postOfficeBox of the User.
-
preferredDeliveryMethod:
string
Delivery method preferred by the User.
-
roomNumber:
array roomNumber
Room Number of the User.
-
secretary:
array secretary
secretary of the User.
-
teletexTerminalIdentifier:
array teletexTerminalIdentifier
teletexTerminalIdentifier value of the User.
-
telexNumber:
array telexNumber
telexNumber of the User.
-
userPKCS12:
array userPKCS12
PKCS #12 PFX PDU for exchange of personal identity information.
-
userSMIMECertificate:
array userSMIMECertificate
PKCS#7 SignedData used to support S/MIME.
-
x500UniqueIdentifier:
array x500UniqueIdentifier
x500UniqueIdentifier of the User.
Nested Schema : items
Type:
object
Allowed Values:
[
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
Nested Schema : addresses
Type:
array
SCIM SubAttributes:
Show Source
- streetAddress
- formatted
- country
- postalCode
- locality
- region
Nested Schema : name
Type:
array
SCIM SubAttributes:
Show Source
- formatted
- givenName
- familyName
Nested Schema : items
Type:
object
Nested Schema : manager
Type:
array
SCIM SubAttributes:
Show Source
- managerId
- displayName
Nested Schema : facsimileTelephoneNumber
Type:
array
facsimileTelephoneNumber of the User.
Show Source
Nested Schema : internationaliSDNNumber
Type:
array
internationaliSDNNumber of the User.
Show Source
Nested Schema : physicalDeliveryOfficeName
Type:
array
Physical Delivery Office Name of the User.
Show Source
Nested Schema : teletexTerminalIdentifier
Type:
array
teletexTerminalIdentifier value of the User.
Show Source
Nested Schema : userPKCS12
Type:
array
PKCS #12 PFX PDU for exchange of personal identity information.
Show Source
Nested Schema : userSMIMECertificate
Type:
array
PKCS#7 SignedData used to support S/MIME.
Show Source
Response
Supported Media Types
- application/scim+json
200 Response
OK
Root Schema : SuccessResponse
Type:
Show Source
object
-
Resources(required):
array Resources
Number of search result entries returned after the LDAP operation.
-
schemas(required):
string
Default Value:
urn:ietf:params:scim:api:messages:2.0:ListResponse
The REST message schema -
totalResults(required):
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : Resources
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : SearchResultEntry
Type:
Show Source
object
-
id:
string
The id of the particular schema.
-
meta:
object meta
The meta values for the particular schema.
-
schemas(required):
string
Allowed Values:
[ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" ]
The Schemas to be included for the schema type. -
urn:ietf:params:scim:schemas:core:2.0:User:
object Core User Properties
-
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
object Enterprise specific User Properties
-
urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User:
object Oracle specific User Properties
Nested Schema : Core User Properties
Type:
Show Source
object
-
addresses:
array addresses
SCIM SubAttributes:
- streetAddress
- formatted
- country
- postalCode
- locality
- region
-
displayName:
array displayName
Display name of the User.
-
emails:
array emails
email of that specific User.
-
name(required):
array name
SCIM SubAttributes:
- formatted
- givenName
- familyName
-
password:
array password
password of that specific User.
-
phoneNumbers:
array phoneNumbers
phoneNumbers of the specific User
-
photos:
array photos
jpeg for the particular User.
-
preferredLanguage:
array preferredLanguage
Preffered Language of that specific User.
-
title:
array title
title of that specific User.
-
userName(required):
array userName
CN (common name) of the entry
-
userType:
array userType
Type of that specific User.
-
x509Certificates:
array x509Certificates
The certificates for the particular User.
Nested Schema : Enterprise specific User Properties
Type:
Show Source
object
-
department:
array department
Department the User is part of.
-
employeeNumber:
array employeeNumber
employeeNumber of the User.
-
manager:
array manager
SCIM SubAttributes:
- managerId
- displayName
-
organization:
array organization
Organization the User is part of.
Nested Schema : Oracle specific User Properties
Type:
Show Source
object
-
businessCategory:
array businessCategory
Business Category of the User.
-
carLicense:
array carLicense
carLicense of the User.
-
description:
array description
Description of the User.
-
destinationIndicator:
array destinationIndicator
Destination Indicator of the User.
-
facsimileTelephoneNumber:
array facsimileTelephoneNumber
facsimileTelephoneNumber of the User.
-
homePhone:
array homePhone
Home Phone number of the User.
-
initials:
array initials
initials of the User.
-
internationaliSDNNumber:
array internationaliSDNNumber
internationaliSDNNumber of the User.
-
labeledURI:
array labeledURI
Uniform Resource Identifier with optional label.
-
mobile:
array mobile
Mobile of the User.
-
objectClass:
array objectClass
Objectclass(es) which this entry belongs to.
-
pager:
array pager
pager of the User.
-
physicalDeliveryOfficeName:
array physicalDeliveryOfficeName
Physical Delivery Office Name of the User.
-
postOfficeBox:
array postOfficeBox
postOfficeBox of the User.
-
preferredDeliveryMethod:
string
Delivery method preferred by the User.
-
roomNumber:
array roomNumber
Room Number of the User.
-
secretary:
array secretary
secretary of the User.
-
teletexTerminalIdentifier:
array teletexTerminalIdentifier
teletexTerminalIdentifier value of the User.
-
telexNumber:
array telexNumber
telexNumber of the User.
-
userPKCS12:
array userPKCS12
PKCS #12 PFX PDU for exchange of personal identity information.
-
userSMIMECertificate:
array userSMIMECertificate
PKCS#7 SignedData used to support S/MIME.
-
x500UniqueIdentifier:
array x500UniqueIdentifier
x500UniqueIdentifier of the User.
Nested Schema : addresses
Type:
array
SCIM SubAttributes:
Show Source
- streetAddress
- formatted
- country
- postalCode
- locality
- region
Nested Schema : name
Type:
array
SCIM SubAttributes:
Show Source
- formatted
- givenName
- familyName
Nested Schema : items
Type:
object
Nested Schema : manager
Type:
array
SCIM SubAttributes:
Show Source
- managerId
- displayName
Nested Schema : facsimileTelephoneNumber
Type:
array
facsimileTelephoneNumber of the User.
Show Source
Nested Schema : internationaliSDNNumber
Type:
array
internationaliSDNNumber of the User.
Show Source
Nested Schema : physicalDeliveryOfficeName
Type:
array
Physical Delivery Office Name of the User.
Show Source
Nested Schema : teletexTerminalIdentifier
Type:
array
teletexTerminalIdentifier value of the User.
Show Source
Nested Schema : userPKCS12
Type:
array
PKCS #12 PFX PDU for exchange of personal identity information.
Show Source
Nested Schema : userSMIMECertificate
Type:
array
PKCS#7 SignedData used to support S/MIME.
Show Source
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
detail(required):
string
Error message returned returned for the operation.
-
schemas(required):
string
Default Value:
urn:ietf:params:scim:api:messages:2.0:Error
The REST message type -
status(required):
integer(int32)
Specifies the HTTP status error code returned for the operation.
409 Response
Conflict
Root Schema : ErrorResponse
Type:
Show Source
object
-
detail(required):
string
Error message returned returned for the operation.
-
schemas(required):
string
Default Value:
urn:ietf:params:scim:api:messages:2.0:Error
The REST message type -
status(required):
integer(int32)
Specifies the HTTP status error code returned for the operation.