Add, Search, Compare or Delete Dsee Gateway Plugin

post

/rest/v1/admin

Add, Search, Compare or Delete Dsee Gateway Plugin

Request

Supported Media Types
Body ()
Dsee Gateway Plugin that needs to be created
Root Schema : Dsee Gateway Plugin POSTRequest
Type: object
Show Source
  • 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.
  • Dsee Gateway Plugin Properties
  • 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
    LDAP controls to be sent to server for the LDAP operation.
  • 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.
  • 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.
  • Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "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
    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.
  • 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 : Dsee Gateway Plugin Properties
Type: object
Show Source
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 : ds-cfg-dsee-specific-attribute-types
Type: array
The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
Default Value: [ "costargettree", "costemplatedn", "cosspecifier", "cosattribute", "cosindirectspecifier", "cospriority", "nsrole", "nsrolescopedn", "nsroledn", "nsroleFilter", "nsaccountlock", "passwordRootdnMayBypassModsChecks", "passwordNonRootMayResetUserpwd", "passwordStorageScheme", "pwdIsLockoutPrioritized", "pwdKeepLastAuthTime", "pwdLastAuthTime", "nsds5ReplConflict", "passwordExpirationTime", "passwordExpWarned", "passwordRetryCount", "retryCountResetTime", "accountUnlockTime", "passwordHistory", "passwordAllowChangeTime", "nsTimeLimit", "nsSizeLimit", "nsLookThroughLimit", "nsIdleTimeout" ]
Show Source
Nested Schema : ds-cfg-dsee-specific-object-classes
Type: array
The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
Default Value: [ "cosDefinition", "cosSuperDefinition", "cosClassicDefinition", "cosPointerDefinition", "cosIndirectDefinition", "costemplate", "nsRoleDefinition", "nsSimpleRoleDefinition", "nsComplexRoleDefinition", "nsManagedRoleDefinition", "nsFilteredRoleDefinition", "nsNestedRoleDefinition", "nsContainer", "sunPwdPolicy", "passwordObject" ]
Show Source
Nested Schema : ds-cfg-plugin-type
Type: array
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Default Value: [ "startup" ]
Allowed Values: [ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Dsee Gateway Plugin SuccessResponse
Type: object
Show Source
Nested Schema : searchResultEntries
Type: array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Dsee Gateway Plugin SearchResultEntry
Type: object
Show Source
Nested Schema : Dsee Gateway Plugin Properties
Type: object
Show Source
Nested Schema : ds-cfg-dsee-specific-attribute-types
Type: array
The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
Default Value: [ "costargettree", "costemplatedn", "cosspecifier", "cosattribute", "cosindirectspecifier", "cospriority", "nsrole", "nsrolescopedn", "nsroledn", "nsroleFilter", "nsaccountlock", "passwordRootdnMayBypassModsChecks", "passwordNonRootMayResetUserpwd", "passwordStorageScheme", "pwdIsLockoutPrioritized", "pwdKeepLastAuthTime", "pwdLastAuthTime", "nsds5ReplConflict", "passwordExpirationTime", "passwordExpWarned", "passwordRetryCount", "retryCountResetTime", "accountUnlockTime", "passwordHistory", "passwordAllowChangeTime", "nsTimeLimit", "nsSizeLimit", "nsLookThroughLimit", "nsIdleTimeout" ]
Show Source
Nested Schema : ds-cfg-dsee-specific-object-classes
Type: array
The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
Default Value: [ "cosDefinition", "cosSuperDefinition", "cosClassicDefinition", "cosPointerDefinition", "cosIndirectDefinition", "costemplate", "nsRoleDefinition", "nsSimpleRoleDefinition", "nsComplexRoleDefinition", "nsManagedRoleDefinition", "nsFilteredRoleDefinition", "nsNestedRoleDefinition", "nsContainer", "sunPwdPolicy", "passwordObject" ]
Show Source
Nested Schema : ds-cfg-plugin-type
Type: array
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Default Value: [ "startup" ]
Allowed Values: [ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source

201 Response

Created
Body ()
Root Schema : Dsee Gateway Plugin ADDResponse
Type: object
Show Source
Nested Schema : searchResultEntries
Type: array
Show Source
Nested Schema : Dsee Gateway Plugin SearchResultEntry
Type: object
Show Source
Nested Schema : Dsee Gateway Plugin Properties
Type: object
Show Source
Nested Schema : ds-cfg-dsee-specific-attribute-types
Type: array
The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
Default Value: [ "costargettree", "costemplatedn", "cosspecifier", "cosattribute", "cosindirectspecifier", "cospriority", "nsrole", "nsrolescopedn", "nsroledn", "nsroleFilter", "nsaccountlock", "passwordRootdnMayBypassModsChecks", "passwordNonRootMayResetUserpwd", "passwordStorageScheme", "pwdIsLockoutPrioritized", "pwdKeepLastAuthTime", "pwdLastAuthTime", "nsds5ReplConflict", "passwordExpirationTime", "passwordExpWarned", "passwordRetryCount", "retryCountResetTime", "accountUnlockTime", "passwordHistory", "passwordAllowChangeTime", "nsTimeLimit", "nsSizeLimit", "nsLookThroughLimit", "nsIdleTimeout" ]
Show Source
Nested Schema : ds-cfg-dsee-specific-object-classes
Type: array
The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
Default Value: [ "cosDefinition", "cosSuperDefinition", "cosClassicDefinition", "cosPointerDefinition", "cosIndirectDefinition", "costemplate", "nsRoleDefinition", "nsSimpleRoleDefinition", "nsComplexRoleDefinition", "nsManagedRoleDefinition", "nsFilteredRoleDefinition", "nsNestedRoleDefinition", "nsContainer", "sunPwdPolicy", "passwordObject" ]
Show Source
Nested Schema : ds-cfg-plugin-type
Type: array
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Default Value: [ "startup" ]
Allowed Values: [ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source

204 Response

No content

406 Response

Not Acceptable
Body ()
Root Schema : ErrorResponse
Type: object
Show Source
Back to Top