Jump to

• Request
• Response

Modify a Seven Bit Clean Plugin by DN

patch

/rest/v1/admin/{dn}

Modify a Seven Bit Clean Plugin by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be modified

Body ()

Seven Bit Clean Plugin that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

• controls(optional): array controls
  LDAP controls to be sent to server for LDAP modify operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  The REST message type
• operations: 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: string
  The entry attribute to be modified.
• opType: string
  Allowed Values: [ "add", "delete", "replace", "increment" ]

  The type of the Patch Operation.
• values(optional): 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Seven Bit Clean Plugin PatchSuccessResponse

Type: object

Show Source

• 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.

{
    "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/Seven Bit Clean Plugin SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Seven Bit Clean Plugin SearchResultEntry

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

Nested Schema : Seven Bit Clean Plugin SearchResultEntry

Type: object

Show Source

• attributes: object Seven Bit Clean Plugin Properties
• dn: 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/Seven Bit Clean Plugin Properties"
        }
    }
}

Nested Schema : Seven Bit Clean Plugin Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-attribute-type: array ds-cfg-attribute-type
  Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean.
• ds-cfg-base-dn(optional): array ds-cfg-base-dn
  Specifies the base DN below which the checking is performed.
• ds-cfg-enabled: boolean
  Indicates whether the plug-in is enabled for use.
• ds-cfg-invoke-for-internal-operations(optional): boolean
  Default Value: true

  Indicates whether the plug-in should be invoked for internal operations.
• ds-cfg-java-class: string
  Default Value: org.opends.server.plugins.SevenBitCleanPlugin

  Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
• ds-cfg-plugin-type: 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: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-plugin-type",
        "ds-cfg-attribute-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":"org.opends.server.plugins.SevenBitCleanPlugin",
            "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-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":[
                "ldifimport",
                "preparseadd",
                "preparsemodify",
                "preparsemodifydn"
            ],
            "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-attribute-type":{
            "description":"Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean. ",
            "readOnly":false,
            "default":[
                "uid",
                "mail",
                "userPassword"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN below which the checking is performed. ",
            "readOnly":false,
            "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-attribute-type

Type: array

Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean.

Default Value: [ "uid", "mail", "userPassword" ]

Show Source

• Array of: string

{
    "description":"Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean. ",
    "readOnly":false,
    "default":[
        "uid",
        "mail",
        "userPassword"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-base-dn

Type: array

Specifies the base DN below which the checking is performed.

Show Source

• Array of: string

{
    "description":"Specifies the base DN below which the checking is performed. ",
    "readOnly":false,
    "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: [ "ldifimport", "preparseadd", "preparsemodify", "preparsemodifydn" ]

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":[
        "ldifimport",
        "preparseadd",
        "preparsemodify",
        "preparsemodifydn"
    ],
    "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

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• 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

{
    "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."
        }
    }
}

Back to Top