REST API for Oracle Unified Directory Administration

Modify a Attribute Mapping by DN

patch

/rest/v1/admin/{dn}

Modify a Attribute Mapping by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Attribute Mapping 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 : Attribute Mapping 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/Attribute Mapping SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Attribute Mapping SearchResultEntry

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

Nested Schema : Attribute Mapping SearchResultEntry

Type: object

Show Source

attributes(required): object Attribute Mapping 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/Attribute Mapping Properties"
        }
    }
}

Nested Schema : Attribute Mapping Properties

Type: object

Show Source

cn: string

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

Name of the attribute to be added
ds-cfg-data-type: string

Allowed Values: [ "bigint", "binary", "bit", "blob", "boolean", "char", "clob", "date", "decimal", "double", "float", "integer", "longnvarchar", "longvarbinary", "longvarchar", "nchar", "nclob", "numeric", "nvarchar", "other", "real", "rowid", "smallint", "time", "timestamp", "tinyint", "varbinary", "varchar" ]

The data type of the attribute value
ds-cfg-field-name(required): string

Field in the specified table from which the value for this attribute has to be populated
ds-cfg-table-name(required): string

Table from which the attribute value has to be fetched. This has to be the alias of one of the RDBMS Tables defined as part of the RDBMS Tables defined for the WorkflowElement
ds-cfg-use-case-sensitive-match: boolean

Default Value: true

Whether case insensitive matching should be used for this attribute or not
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-field-name",
        "ds-cfg-attribute-name",
        "ds-cfg-table-name"
    ],
    "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-field-name":{
            "description":"Field in the specified table from which the value for this attribute has to be populated ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-use-case-sensitive-match":{
            "description":"Whether case insensitive matching should be used for this attribute or not ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-attribute-name":{
            "description":"Name of the attribute to be added ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-table-name":{
            "description":"Table from which the attribute value has to be fetched. This has to be the alias of one of the RDBMS Tables defined as part of the RDBMS Tables defined for the WorkflowElement ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-data-type":{
            "description":"The data type of the attribute value ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "bigint",
                "binary",
                "bit",
                "blob",
                "boolean",
                "char",
                "clob",
                "date",
                "decimal",
                "double",
                "float",
                "integer",
                "longnvarchar",
                "longvarbinary",
                "longvarchar",
                "nchar",
                "nclob",
                "numeric",
                "nvarchar",
                "other",
                "real",
                "rowid",
                "smallint",
                "time",
                "timestamp",
                "tinyint",
                "varbinary",
                "varchar"
            ]
        }
    }
}

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