Jump to

• Request
• Response

Modify a Root DN by DN

patch

/rest/v1/admin/{dn}

Modify a Root DN by DN

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root DN 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 : Root DN 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/Root DN SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Root DN SearchResultEntry

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

Nested Schema : Root DN SearchResultEntry

Type: object

Show Source

• attributes: object Root DN 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/Root DN Properties"
        }
    }
}

Nested Schema : Root DN Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-default-root-privilege-name(optional): array ds-cfg-default-root-privilege-name
  Specifies the names of the privileges that root users will be granted by default.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass"
    ],
    "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-default-root-privilege-name":{
            "description":"Specifies the names of the privileges that root users will be granted by default. ",
            "readOnly":false,
            "default":[
                "bypass-lockdown",
                "bypass-acl",
                "modify-acl",
                "config-read",
                "config-write",
                "ldif-import",
                "ldif-export",
                "backend-backup",
                "backend-restore",
                "server-shutdown",
                "server-restart",
                "disconnect-client",
                "cancel-request",
                "password-reset",
                "update-schema",
                "privilege-change",
                "unindexed-search",
                "subentry-write"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "backend-backup",
                "backend-restore",
                "bypass-acl",
                "bypass-lockdown",
                "cancel-request",
                "config-read",
                "config-write",
                "disconnect-client",
                "jmx-notify",
                "jmx-read",
                "jmx-write",
                "ldif-export",
                "ldif-import",
                "modify-acl",
                "password-reset",
                "privilege-change",
                "proxied-auth",
                "server-restart",
                "server-shutdown",
                "subentry-write",
                "unindexed-search",
                "update-schema"
            ]
        }
    }
}

Nested Schema : ds-cfg-default-root-privilege-name

Type: array

Specifies the names of the privileges that root users will be granted by default.

Default Value: [ "bypass-lockdown", "bypass-acl", "modify-acl", "config-read", "config-write", "ldif-import", "ldif-export", "backend-backup", "backend-restore", "server-shutdown", "server-restart", "disconnect-client", "cancel-request", "password-reset", "update-schema", "privilege-change", "unindexed-search", "subentry-write" ]

Allowed Values: [ "backend-backup", "backend-restore", "bypass-acl", "bypass-lockdown", "cancel-request", "config-read", "config-write", "disconnect-client", "jmx-notify", "jmx-read", "jmx-write", "ldif-export", "ldif-import", "modify-acl", "password-reset", "privilege-change", "proxied-auth", "server-restart", "server-shutdown", "subentry-write", "unindexed-search", "update-schema" ]

Show Source

• Array of: string

{
    "description":"Specifies the names of the privileges that root users will be granted by default. ",
    "readOnly":false,
    "default":[
        "bypass-lockdown",
        "bypass-acl",
        "modify-acl",
        "config-read",
        "config-write",
        "ldif-import",
        "ldif-export",
        "backend-backup",
        "backend-restore",
        "server-shutdown",
        "server-restart",
        "disconnect-client",
        "cancel-request",
        "password-reset",
        "update-schema",
        "privilege-change",
        "unindexed-search",
        "subentry-write"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "backend-backup",
        "backend-restore",
        "bypass-acl",
        "bypass-lockdown",
        "cancel-request",
        "config-read",
        "config-write",
        "disconnect-client",
        "jmx-notify",
        "jmx-read",
        "jmx-write",
        "ldif-export",
        "ldif-import",
        "modify-acl",
        "password-reset",
        "privilege-change",
        "proxied-auth",
        "server-restart",
        "server-shutdown",
        "subentry-write",
        "unindexed-search",
        "update-schema"
    ]
}

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