REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete Objectclass Mapping

post

/rest/v1/admin

Add, Search, Compare or Delete Objectclass Mapping

Request

Supported Media Types

application/json

Objectclass Mapping that needs to be created

Root Schema : Objectclass Mapping POSTRequest

Type: object

Show Source

assertion: string

Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
attributes: object Objectclass Mapping Properties
base: string

Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
controls: array controls

LDAP controls to be sent to server for the LDAP operation.
dn: string

LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
filter: string

Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
msgType(required): string

Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

The REST message type
requiredAttributes: array requiredAttributes

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
scope: string

Allowed Values: [ "base", "sub", "one" ]

Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Objectclass Mapping Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

Nested Schema : Objectclass Mapping Properties

Type: object

Show Source

cn: string

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

The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object.
ds-cfg-rdn-attribute(required): string

This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

Nested Schema : controls

Type: array

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

Show Source

Array of: string

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

Nested Schema : requiredAttributes

Type: array

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

Show Source

Array of: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "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"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Objectclass Mapping SuccessResponse

Type: object

Show Source

compareResult: boolean

Indicates the result of LDAP compare operation.
msgType(required): string

Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

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",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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/Objectclass Mapping SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Objectclass Mapping SearchResultEntry

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

Nested Schema : Objectclass Mapping SearchResultEntry

Type: object

Show Source

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

Nested Schema : Objectclass Mapping Properties

Type: object

Show Source

cn: string

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

The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object.
ds-cfg-rdn-attribute(required): string

This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "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"
    }
}

201 Response

Created

Root Schema : Objectclass Mapping ADDResponse

Type: object

Show Source

msgType(required): string

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

The REST message type
searchResultEntries(required): array searchResultEntries
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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Objectclass Mapping SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object Objectclass Mapping SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Objectclass Mapping SearchResultEntry"
    }
}

Nested Schema : Objectclass Mapping SearchResultEntry

Type: object

Show Source

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

Nested Schema : Objectclass Mapping Properties

Type: object

Show Source

cn: string

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

The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object.
ds-cfg-rdn-attribute(required): string

This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "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"
    }
}

204 Response

No content

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