Add, Delete, Search, Modify or Compare an OUD entry.
post
/rest/v1/directory
Add, Delete, Search, Modify or Compare an entry in the directory.
Request
Supported Media Types
- application/json
User that needs to be created
Root Schema : POSTRequest
Type:
Show Source
object
-
assertion:
string
Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
-
attributes:
object Properties
-
base:
string
Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
-
controls:
array controls
LDAP controls to be sent to server for the LDAP operation.
-
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.
-
filter:
string
Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
-
msgType(required):
string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
The REST message type -
requiredAttributes:
array requiredAttributes
List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
-
scope:
string
Allowed Values:
[ "base", "sub", "one" ]
Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
Nested Schema : Properties
Type:
Show Source
object
-
audio:
array audio
audio for the corresponding entry
-
businessCategory:
array businessCategory
businessCategory for the corresponding entry
-
carLicense:
array carLicense
carLicense for the corresponding entry
-
cn(required):
array cn
cn for the corresponding entry
-
departmentNumber:
array departmentNumber
departmentNumber for the corresponding entry
-
description:
array description
description for the corresponding entry
-
destinationIndicator:
array destinationIndicator
destinationIndicator for the corresponding entry
-
displayName:
array displayName
displayName for the corresponding entry
-
employeeNumber:
array employeeNumber
employeeNumber for the corresponding entry
-
employeeType:
array employeeType
employeeType for the corresponding entry
-
facsimileTelephoneNumber:
array facsimileTelephoneNumber
facsimileTelephoneNumber for the corresponding entry
-
givenName:
array givenName
givenName for the corresponding entry
-
homePhone:
array homePhone
homePhone for the corresponding entry
-
homePostalAddress:
array homePostalAddress
homePostalAddress for the corresponding entry
-
initials:
array initials
initials for the corresponding entry
-
internationaliSDNNumber:
array internationaliSDNNumber
internationaliSDNNumber for the corresponding entry
-
jpegPhoto:
array jpegPhoto
jpegPhoto for the corresponding entry
-
l:
array l
l for the corresponding entry
-
labeledURI:
array labeledURI
labeledURI for the corresponding entry
-
mail:
array mail
mail for the corresponding entry
-
manager:
array manager
manager for the corresponding entry
-
mobile:
array mobile
mobile for the corresponding entry
-
o:
array o
o for the corresponding entry
-
objectClass(required):
array objectClass
objectClass for the corresponding entry
-
ou:
array ou
ou for the corresponding entry
-
pager:
array pager
pager for the corresponding entry
-
photo:
array photo
photo for the corresponding entry
-
physicalDeliveryOfficeName:
array physicalDeliveryOfficeName
physicalDeliveryOfficeName for the corresponding entry
-
postalAddress:
array postalAddress
postalAddress for the corresponding entry
-
postalCode:
array postalCode
postalCode for the corresponding entry
-
postOfficeBox:
array postOfficeBox
postOfficeBox for the corresponding entry
-
preferredDeliveryMethod:
array preferredDeliveryMethod
preferredDeliveryMethod for the corresponding entry
-
preferredLanguage:
array preferredLanguage
preferredLanguage for the corresponding entry
-
registeredAddress:
array registeredAddress
registeredAddress for the corresponding entry
-
roomNumber:
array roomNumber
roomNumber for the corresponding entry
-
secretary:
array secretary
secretary for the corresponding entry
-
seeAlso:
array seeAlso
seeAlso for the corresponding entry
-
sn:
array sn
sn for the corresponding entry
-
st:
array st
st for the corresponding entry
-
street:
array street
street for the corresponding entry
-
telephoneNumber:
array telephoneNumber
telephoneNumber for the corresponding entry
-
teletexTerminalIdentifier:
array teletexTerminalIdentifier
teletexTerminalIdentifier for the corresponding entry
-
telexNumber:
array telexNumber
telexNumber for the corresponding entry
-
title:
array title
title for the corresponding entry
-
uid:
array uid
uid for the corresponding entry
-
userCertificate:
array userCertificate
userCertificate for the corresponding entry
-
userPassword:
array userPassword
userPassword for the corresponding entry
-
userPKCS12:
array userPKCS12
userPKCS12 for the corresponding entry
-
userSMIMECertificate:
array userSMIMECertificate
userSMIMECertificate for the corresponding entry
-
x121Address:
array x121Address
x121Address for the corresponding entry
-
x500UniqueIdentifier:
array x500UniqueIdentifier
x500UniqueIdentifier for the corresponding entry
Nested Schema : controls
Type:
array
LDAP controls to be sent to server for the LDAP operation.
Show Source
Nested Schema : requiredAttributes
Type:
array
List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
Show Source
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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : SuccessResponse
Type:
Show Source
object
-
compareResult:
boolean
Indicates the result of LDAP compare operation.
-
msgType(required):
string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
The REST message type -
searchResultEntries(required):
array searchResultEntries
Number of search result entries returned after the LDAP operation.
-
totalResults(required):
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(required):
object Properties
-
dn(required):
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:
array audio
audio for the corresponding entry
-
businessCategory:
array businessCategory
businessCategory for the corresponding entry
-
carLicense:
array carLicense
carLicense for the corresponding entry
-
cn(required):
array cn
cn for the corresponding entry
-
departmentNumber:
array departmentNumber
departmentNumber for the corresponding entry
-
description:
array description
description for the corresponding entry
-
destinationIndicator:
array destinationIndicator
destinationIndicator for the corresponding entry
-
displayName:
array displayName
displayName for the corresponding entry
-
employeeNumber:
array employeeNumber
employeeNumber for the corresponding entry
-
employeeType:
array employeeType
employeeType for the corresponding entry
-
facsimileTelephoneNumber:
array facsimileTelephoneNumber
facsimileTelephoneNumber for the corresponding entry
-
givenName:
array givenName
givenName for the corresponding entry
-
homePhone:
array homePhone
homePhone for the corresponding entry
-
homePostalAddress:
array homePostalAddress
homePostalAddress for the corresponding entry
-
initials:
array initials
initials for the corresponding entry
-
internationaliSDNNumber:
array internationaliSDNNumber
internationaliSDNNumber for the corresponding entry
-
jpegPhoto:
array jpegPhoto
jpegPhoto for the corresponding entry
-
l:
array l
l for the corresponding entry
-
labeledURI:
array labeledURI
labeledURI for the corresponding entry
-
mail:
array mail
mail for the corresponding entry
-
manager:
array manager
manager for the corresponding entry
-
mobile:
array mobile
mobile for the corresponding entry
-
o:
array o
o for the corresponding entry
-
objectClass(required):
array objectClass
objectClass for the corresponding entry
-
ou:
array ou
ou for the corresponding entry
-
pager:
array pager
pager for the corresponding entry
-
photo:
array photo
photo for the corresponding entry
-
physicalDeliveryOfficeName:
array physicalDeliveryOfficeName
physicalDeliveryOfficeName for the corresponding entry
-
postalAddress:
array postalAddress
postalAddress for the corresponding entry
-
postalCode:
array postalCode
postalCode for the corresponding entry
-
postOfficeBox:
array postOfficeBox
postOfficeBox for the corresponding entry
-
preferredDeliveryMethod:
array preferredDeliveryMethod
preferredDeliveryMethod for the corresponding entry
-
preferredLanguage:
array preferredLanguage
preferredLanguage for the corresponding entry
-
registeredAddress:
array registeredAddress
registeredAddress for the corresponding entry
-
roomNumber:
array roomNumber
roomNumber for the corresponding entry
-
secretary:
array secretary
secretary for the corresponding entry
-
seeAlso:
array seeAlso
seeAlso for the corresponding entry
-
sn:
array sn
sn for the corresponding entry
-
st:
array st
st for the corresponding entry
-
street:
array street
street for the corresponding entry
-
telephoneNumber:
array telephoneNumber
telephoneNumber for the corresponding entry
-
teletexTerminalIdentifier:
array teletexTerminalIdentifier
teletexTerminalIdentifier for the corresponding entry
-
telexNumber:
array telexNumber
telexNumber for the corresponding entry
-
title:
array title
title for the corresponding entry
-
uid:
array uid
uid for the corresponding entry
-
userCertificate:
array userCertificate
userCertificate for the corresponding entry
-
userPassword:
array userPassword
userPassword for the corresponding entry
-
userPKCS12:
array userPKCS12
userPKCS12 for the corresponding entry
-
userSMIMECertificate:
array userSMIMECertificate
userSMIMECertificate for the corresponding entry
-
x121Address:
array x121Address
x121Address for the corresponding entry
-
x500UniqueIdentifier:
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
201 Response
Created
Root Schema : ADDSuccessResponse
Type:
Show Source
object
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
The REST message type -
searchResultEntries(required):
array searchResultEntries
-
totalResults(required):
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : SearchResultEntry
Type:
Show Source
object
-
attributes(required):
object Properties
-
dn(required):
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:
array audio
audio for the corresponding entry
-
businessCategory:
array businessCategory
businessCategory for the corresponding entry
-
carLicense:
array carLicense
carLicense for the corresponding entry
-
cn(required):
array cn
cn for the corresponding entry
-
departmentNumber:
array departmentNumber
departmentNumber for the corresponding entry
-
description:
array description
description for the corresponding entry
-
destinationIndicator:
array destinationIndicator
destinationIndicator for the corresponding entry
-
displayName:
array displayName
displayName for the corresponding entry
-
employeeNumber:
array employeeNumber
employeeNumber for the corresponding entry
-
employeeType:
array employeeType
employeeType for the corresponding entry
-
facsimileTelephoneNumber:
array facsimileTelephoneNumber
facsimileTelephoneNumber for the corresponding entry
-
givenName:
array givenName
givenName for the corresponding entry
-
homePhone:
array homePhone
homePhone for the corresponding entry
-
homePostalAddress:
array homePostalAddress
homePostalAddress for the corresponding entry
-
initials:
array initials
initials for the corresponding entry
-
internationaliSDNNumber:
array internationaliSDNNumber
internationaliSDNNumber for the corresponding entry
-
jpegPhoto:
array jpegPhoto
jpegPhoto for the corresponding entry
-
l:
array l
l for the corresponding entry
-
labeledURI:
array labeledURI
labeledURI for the corresponding entry
-
mail:
array mail
mail for the corresponding entry
-
manager:
array manager
manager for the corresponding entry
-
mobile:
array mobile
mobile for the corresponding entry
-
o:
array o
o for the corresponding entry
-
objectClass(required):
array objectClass
objectClass for the corresponding entry
-
ou:
array ou
ou for the corresponding entry
-
pager:
array pager
pager for the corresponding entry
-
photo:
array photo
photo for the corresponding entry
-
physicalDeliveryOfficeName:
array physicalDeliveryOfficeName
physicalDeliveryOfficeName for the corresponding entry
-
postalAddress:
array postalAddress
postalAddress for the corresponding entry
-
postalCode:
array postalCode
postalCode for the corresponding entry
-
postOfficeBox:
array postOfficeBox
postOfficeBox for the corresponding entry
-
preferredDeliveryMethod:
array preferredDeliveryMethod
preferredDeliveryMethod for the corresponding entry
-
preferredLanguage:
array preferredLanguage
preferredLanguage for the corresponding entry
-
registeredAddress:
array registeredAddress
registeredAddress for the corresponding entry
-
roomNumber:
array roomNumber
roomNumber for the corresponding entry
-
secretary:
array secretary
secretary for the corresponding entry
-
seeAlso:
array seeAlso
seeAlso for the corresponding entry
-
sn:
array sn
sn for the corresponding entry
-
st:
array st
st for the corresponding entry
-
street:
array street
street for the corresponding entry
-
telephoneNumber:
array telephoneNumber
telephoneNumber for the corresponding entry
-
teletexTerminalIdentifier:
array teletexTerminalIdentifier
teletexTerminalIdentifier for the corresponding entry
-
telexNumber:
array telexNumber
telexNumber for the corresponding entry
-
title:
array title
title for the corresponding entry
-
uid:
array uid
uid for the corresponding entry
-
userCertificate:
array userCertificate
userCertificate for the corresponding entry
-
userPassword:
array userPassword
userPassword for the corresponding entry
-
userPKCS12:
array userPKCS12
userPKCS12 for the corresponding entry
-
userSMIMECertificate:
array userSMIMECertificate
userSMIMECertificate for the corresponding entry
-
x121Address:
array x121Address
x121Address for the corresponding entry
-
x500UniqueIdentifier:
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
204 Response
No content
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
ldapErrorCode:
integer(int32)
Specifies the LDAP error code returned for the operation.
-
message(required):
string
Error message returned returned for the operation.
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
The REST message type