REST API for Oracle Unified Directory Administration

Modify a Dsee Gateway Plugin by DN

patch

/rest/v1/admin/{dn}

Modify a Dsee Gateway Plugin by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Dsee Gateway Plugin that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

controls: array controls

LDAP controls to be sent to server for LDAP modify operation.
msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

The REST message type
operations(required): array operations

Modifications (Patch operations) to be performed on the entry.

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for LDAP modify operation.

Show Source

Array of: string

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : operations

Type: array

Modifications (Patch operations) to be performed on the entry.

Show Source

Array of: object PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

Nested Schema : PatchOperation

Type: object

Show Source

attribute(required): string

The entry attribute to be modified.
opType(required): string

Allowed Values: [ "add", "delete", "replace", "increment" ]

The type of the Patch Operation.
values: array values

The attribute values to be updated.

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : values

Type: array

The attribute values to be updated.

Show Source

Array of: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Dsee Gateway Plugin PatchSuccessResponse

Type: object

Show Source

msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

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.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Dsee Gateway Plugin SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Dsee Gateway Plugin SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Dsee Gateway Plugin SearchResultEntry"
    }
}

Nested Schema : Dsee Gateway Plugin SearchResultEntry

Type: object

Show Source

attributes(required): object Dsee Gateway Plugin Properties
dn(required): string

LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Dsee Gateway Plugin Properties"
        }
    }
}

Nested Schema : Dsee Gateway Plugin Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-dsee-specific-attribute-types: array ds-cfg-dsee-specific-attribute-types

The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
ds-cfg-dsee-specific-filtering-enabled: boolean

Default Value: true

Indicates whether the dsee specific object classes and/or attribute types are filtered
ds-cfg-dsee-specific-object-classes: array ds-cfg-dsee-specific-object-classes

The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers.
ds-cfg-enabled(required): boolean

Indicates whether the plug-in is enabled for use.
ds-cfg-invoke-for-internal-operations: boolean

Default Value: true

Indicates whether the plug-in should be invoked for internal operations.
ds-cfg-java-class(required): string

Default Value: com.sun.gateway.server.DseeGatewayPlugin

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
ds-cfg-plugin-type(required): array ds-cfg-plugin-type

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-plugin-type",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the plug-in implementation. ",
            "readOnly":false,
            "default":"com.sun.gateway.server.DseeGatewayPlugin",
            "type":"string"
        },
        "ds-cfg-invoke-for-internal-operations":{
            "description":"Indicates whether the plug-in should be invoked for internal operations. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dsee-specific-filtering-enabled":{
            "description":"Indicates whether the dsee specific object classes and/or attribute types are filtered ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-plugin-type":{
            "description":"Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. ",
            "readOnly":false,
            "default":[
                "startup"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "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"
            ]
        },
        "ds-cfg-dsee-specific-attribute-types":{
            "description":"The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
            "readOnly":false,
            "default":[
                "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"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dsee-specific-object-classes":{
            "description":"The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
            "readOnly":false,
            "default":[
                "cosDefinition",
                "cosSuperDefinition",
                "cosClassicDefinition",
                "cosPointerDefinition",
                "cosIndirectDefinition",
                "costemplate",
                "nsRoleDefinition",
                "nsSimpleRoleDefinition",
                "nsComplexRoleDefinition",
                "nsManagedRoleDefinition",
                "nsFilteredRoleDefinition",
                "nsNestedRoleDefinition",
                "nsContainer",
                "sunPwdPolicy",
                "passwordObject"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the plug-in is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

Array of: string

{
    "description":"The attributes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
    "readOnly":false,
    "default":[
        "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"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Array of: string

{
    "description":"The object classes that are specific to ODSEE servers and should not be propagated to Oracle Unified Directory servers. ",
    "readOnly":false,
    "default":[
        "cosDefinition",
        "cosSuperDefinition",
        "cosClassicDefinition",
        "cosPointerDefinition",
        "cosIndirectDefinition",
        "costemplate",
        "nsRoleDefinition",
        "nsSimpleRoleDefinition",
        "nsComplexRoleDefinition",
        "nsManagedRoleDefinition",
        "nsFilteredRoleDefinition",
        "nsNestedRoleDefinition",
        "nsContainer",
        "sunPwdPolicy",
        "passwordObject"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Array of: string

{
    "description":"Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. ",
    "readOnly":false,
    "default":[
        "startup"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "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"
    ]
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

400 Response

ERROR

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}