REST API for Oracle Unified Directory Administration

Modify a Entry UUID Virtual Attribute by DN

patch

/rest/v1/admin/{dn}

Modify a Entry UUID Virtual Attribute by DN

Request

Supported Media Types

application/json

Path Parameters

dn: string

LDAP DN of the entry to be modified

Entry UUID Virtual Attribute 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"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Entry UUID Virtual Attribute 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/Entry UUID Virtual Attribute SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Entry UUID Virtual Attribute SearchResultEntry


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

Nested Schema : Entry UUID Virtual Attribute SearchResultEntry

Type: object

Show Source

attributes: object Entry UUID Virtual Attribute 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/Entry UUID Virtual Attribute Properties"
        }
    }
}

Nested Schema : Entry UUID Virtual Attribute Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-attribute-type: string

Default Value: entryUUID

Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
ds-cfg-base-dn(optional): array ds-cfg-base-dn

Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.
ds-cfg-conflict-behavior(optional): string

Default Value: real-overrides-virtual

Allowed Values: [ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]

Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.
ds-cfg-enabled: boolean

Indicates whether the Virtual Attribute is enabled for use.
ds-cfg-filter(optional): array ds-cfg-filter

Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.
ds-cfg-group-dn(optional): array ds-cfg-group-dn

Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.
ds-cfg-java-class: string

Default Value: org.opends.server.extensions.EntryUUIDVirtualAttributeProvider

Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "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-filter":{
            "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
            "readOnly":false,
            "default":[
                "(objectClass=*)"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.EntryUUIDVirtualAttributeProvider",
            "type":"string"
        },
        "ds-cfg-conflict-behavior":{
            "description":"Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. ",
            "readOnly":false,
            "default":"real-overrides-virtual",
            "type":"string",
            "enum":[
                "merge-real-and-virtual",
                "real-overrides-virtual",
                "virtual-overrides-real"
            ]
        },
        "ds-cfg-group-dn":{
            "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute-type":{
            "description":"Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute. ",
            "readOnly":false,
            "default":"entryUUID",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Virtual Attribute is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-base-dn

Type: array

Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

Show Source

Array of: string


{
    "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-filter

Type: array

Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

Default Value:

[
    "(objectClass=*)"
]

Show Source

Array of: string


{
    "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
    "readOnly":false,
    "default":[
        "(objectClass=*)"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-group-dn

Type: array

Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

Show Source

Array of: string


{
    "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Oracle Account

Oracle Account

Sign in to Cloud

REST API for Oracle Unified Directory Administration

Modify a Entry UUID Virtual Attribute by DN

Request

Response

200 Response

400 Response

406 Response