Modify a OUD entry
patch
/rest/v1/directory/{dn}
Modify an entry by giving the dn
Request
Supported Media Types
- application/json
Path Parameters
-
dn: string
LDAP DN of the entry to be modified
Entry that needs to be modified
Root Schema : PatchRequest
Type:
Show Source
object
-
deleteOldRdn(optional):
boolean
Whether you want to delete the values of the older Rdn
-
msgType:
string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyDNRequest" ]
The schema for the Patch operation type -
newRdn(optional):
string
The new Rdn value for the entry. Mandatory for ModifyDNRequest
-
newSuperior(optional):
string
The new Superior attribute for the following entry
-
Operations(optional):
array Operations
Modifications (Patch operations) to be performed on the User.
Nested Schema : Operations
Type:
array
Modifications (Patch operations) to be performed on the User.
Show Source
Nested Schema : PatchOperation
Type:
Show Source
object
-
opType:
string
Allowed Values:
[ "add", "delete", "replace", "increment" ]
The type of the Patch Operation. -
path(optional):
string
The path of the entry attribute to be modified.
-
values:
array values
The attribute values to be updated.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : PatchSuccessResponse
Type:
Show Source
object
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse
The REST message type -
searchResultEntries:
array searchResultEntries
Number of search result entries returned after the LDAP operation.
-
totalResults:
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : SearchResultEntry
Type:
Show Source
object
-
attributes:
object Properties
-
dn:
string
LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
Nested Schema : Properties
Type:
Show Source
object
-
audio(optional):
array audio
audio for the corresponding entry
-
businessCategory(optional):
array businessCategory
businessCategory for the corresponding entry
-
carLicense(optional):
array carLicense
carLicense for the corresponding entry
-
cn:
array cn
cn for the corresponding entry
-
departmentNumber(optional):
array departmentNumber
departmentNumber for the corresponding entry
-
description(optional):
array description
description for the corresponding entry
-
destinationIndicator(optional):
array destinationIndicator
destinationIndicator for the corresponding entry
-
displayName(optional):
array displayName
displayName for the corresponding entry
-
employeeNumber(optional):
array employeeNumber
employeeNumber for the corresponding entry
-
employeeType(optional):
array employeeType
employeeType for the corresponding entry
-
facsimileTelephoneNumber(optional):
array facsimileTelephoneNumber
facsimileTelephoneNumber for the corresponding entry
-
givenName(optional):
array givenName
givenName for the corresponding entry
-
homePhone(optional):
array homePhone
homePhone for the corresponding entry
-
homePostalAddress(optional):
array homePostalAddress
homePostalAddress for the corresponding entry
-
initials(optional):
array initials
initials for the corresponding entry
-
internationaliSDNNumber(optional):
array internationaliSDNNumber
internationaliSDNNumber for the corresponding entry
-
jpegPhoto(optional):
array jpegPhoto
jpegPhoto for the corresponding entry
-
l(optional):
array l
l for the corresponding entry
-
labeledURI(optional):
array labeledURI
labeledURI for the corresponding entry
-
mail(optional):
array mail
mail for the corresponding entry
-
manager(optional):
array manager
manager for the corresponding entry
-
mobile(optional):
array mobile
mobile for the corresponding entry
-
o(optional):
array o
o for the corresponding entry
-
objectClass:
array objectClass
objectClass for the corresponding entry
-
ou(optional):
array ou
ou for the corresponding entry
-
pager(optional):
array pager
pager for the corresponding entry
-
photo(optional):
array photo
photo for the corresponding entry
-
physicalDeliveryOfficeName(optional):
array physicalDeliveryOfficeName
physicalDeliveryOfficeName for the corresponding entry
-
postalAddress(optional):
array postalAddress
postalAddress for the corresponding entry
-
postalCode(optional):
array postalCode
postalCode for the corresponding entry
-
postOfficeBox(optional):
array postOfficeBox
postOfficeBox for the corresponding entry
-
preferredDeliveryMethod(optional):
array preferredDeliveryMethod
preferredDeliveryMethod for the corresponding entry
-
preferredLanguage(optional):
array preferredLanguage
preferredLanguage for the corresponding entry
-
registeredAddress(optional):
array registeredAddress
registeredAddress for the corresponding entry
-
roomNumber(optional):
array roomNumber
roomNumber for the corresponding entry
-
secretary(optional):
array secretary
secretary for the corresponding entry
-
seeAlso(optional):
array seeAlso
seeAlso for the corresponding entry
-
sn(optional):
array sn
sn for the corresponding entry
-
st(optional):
array st
st for the corresponding entry
-
street(optional):
array street
street for the corresponding entry
-
telephoneNumber(optional):
array telephoneNumber
telephoneNumber for the corresponding entry
-
teletexTerminalIdentifier(optional):
array teletexTerminalIdentifier
teletexTerminalIdentifier for the corresponding entry
-
telexNumber(optional):
array telexNumber
telexNumber for the corresponding entry
-
title(optional):
array title
title for the corresponding entry
-
uid(optional):
array uid
uid for the corresponding entry
-
userCertificate(optional):
array userCertificate
userCertificate for the corresponding entry
-
userPassword(optional):
array userPassword
userPassword for the corresponding entry
-
userPKCS12(optional):
array userPKCS12
userPKCS12 for the corresponding entry
-
userSMIMECertificate(optional):
array userSMIMECertificate
userSMIMECertificate for the corresponding entry
-
x121Address(optional):
array x121Address
x121Address for the corresponding entry
-
x500UniqueIdentifier(optional):
array x500UniqueIdentifier
x500UniqueIdentifier for the corresponding entry
Nested Schema : businessCategory
Type:
array
businessCategory for the corresponding entry
Show Source
Nested Schema : departmentNumber
Type:
array
departmentNumber for the corresponding entry
Show Source
Nested Schema : destinationIndicator
Type:
array
destinationIndicator for the corresponding entry
Show Source
Nested Schema : facsimileTelephoneNumber
Type:
array
facsimileTelephoneNumber for the corresponding entry
Show Source
Nested Schema : homePostalAddress
Type:
array
homePostalAddress for the corresponding entry
Show Source
Nested Schema : internationaliSDNNumber
Type:
array
internationaliSDNNumber for the corresponding entry
Show Source
Nested Schema : physicalDeliveryOfficeName
Type:
array
physicalDeliveryOfficeName for the corresponding entry
Show Source
Nested Schema : preferredDeliveryMethod
Type:
array
preferredDeliveryMethod for the corresponding entry
Show Source
Nested Schema : preferredLanguage
Type:
array
preferredLanguage for the corresponding entry
Show Source
Nested Schema : registeredAddress
Type:
array
registeredAddress for the corresponding entry
Show Source
Nested Schema : teletexTerminalIdentifier
Type:
array
teletexTerminalIdentifier for the corresponding entry
Show Source
Nested Schema : userSMIMECertificate
Type:
array
userSMIMECertificate for the corresponding entry
Show Source
Nested Schema : x500UniqueIdentifier
Type:
array
x500UniqueIdentifier for the corresponding entry
Show Source
400 Response
ERROR
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
ldapErrorCode(optional):
integer(int32)
Specifies the LDAP error code returned for the operation.
-
message:
string
Error message returned returned for the operation.
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
The REST message type