REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete Subject DN To User Attribute Certificate Mapper

post

/rest/v1/admin

Add, Search, Compare or Delete Subject DN To User Attribute Certificate Mapper

Request

Supported Media Types

application/json

Subject DN To User Attribute Certificate Mapper that needs to be created

Root Schema : Subject DN To User Attribute Certificate Mapper POSTRequest

Type: object

Show Source

assertion(optional): 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(optional): object Subject DN To User Attribute Certificate Mapper Properties
base(optional): 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(optional): array controls

LDAP controls to be sent to server for the LDAP operation.
dn(optional): 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(optional): 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: 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(optional): 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(optional): 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/Subject DN To User Attribute Certificate Mapper 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 : Subject DN To User Attribute Certificate Mapper Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-enabled: boolean

Indicates whether the Certificate Mapper is enabled.
ds-cfg-java-class: string

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

Specifies the fully-qualified name of the Java class that provides the Subject DN To User Attribute Certificate Mapper implementation.
ds-cfg-subject-attribute: string

Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN.
ds-cfg-user-base-dn(optional): array ds-cfg-user-base-dn

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-subject-attribute",
        "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 Subject DN To User Attribute Certificate Mapper implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.SubjectDNToUserAttributeCertificateMapper",
            "type":"string"
        },
        "ds-cfg-user-base-dn":{
            "description":"Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-subject-attribute":{
            "description":"Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Certificate Mapper is enabled. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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 : ds-cfg-user-base-dn

Type: array

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.

Show Source

Array of: string


{
    "description":"Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry. ",
    "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"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Subject DN To User Attribute Certificate Mapper SuccessResponse

Type: object

Show Source

compareResult(optional): boolean

Indicates the result of LDAP compare operation.
msgType: 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: 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",
            "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/Subject DN To User Attribute Certificate Mapper 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 Subject DN To User Attribute Certificate Mapper SearchResultEntry


{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Subject DN To User Attribute Certificate Mapper SearchResultEntry"
    }
}

Nested Schema : Subject DN To User Attribute Certificate Mapper SearchResultEntry

Type: object

Show Source

attributes: object Subject DN To User Attribute Certificate Mapper 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/Subject DN To User Attribute Certificate Mapper Properties"
        }
    }
}

Nested Schema : Subject DN To User Attribute Certificate Mapper Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-enabled: boolean

Indicates whether the Certificate Mapper is enabled.
ds-cfg-java-class: string

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

Specifies the fully-qualified name of the Java class that provides the Subject DN To User Attribute Certificate Mapper implementation.
ds-cfg-subject-attribute: string

Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN.
ds-cfg-user-base-dn(optional): array ds-cfg-user-base-dn

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-subject-attribute",
        "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 Subject DN To User Attribute Certificate Mapper implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.SubjectDNToUserAttributeCertificateMapper",
            "type":"string"
        },
        "ds-cfg-user-base-dn":{
            "description":"Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-subject-attribute":{
            "description":"Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Certificate Mapper is enabled. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-user-base-dn

Type: array

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.

Show Source

Array of: string


{
    "description":"Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry. ",
    "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"
    }
}

201 Response

Created

Root Schema : Subject DN To User Attribute Certificate Mapper ADDResponse

Type: object

Show Source

msgType: string

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

The REST message type
searchResultEntries: array searchResultEntries
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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Subject DN To User Attribute Certificate Mapper SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object Subject DN To User Attribute Certificate Mapper SearchResultEntry


{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Subject DN To User Attribute Certificate Mapper SearchResultEntry"
    }
}

Nested Schema : Subject DN To User Attribute Certificate Mapper SearchResultEntry

Type: object

Show Source

attributes: object Subject DN To User Attribute Certificate Mapper 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/Subject DN To User Attribute Certificate Mapper Properties"
        }
    }
}

Nested Schema : Subject DN To User Attribute Certificate Mapper Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-enabled: boolean

Indicates whether the Certificate Mapper is enabled.
ds-cfg-java-class: string

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

Specifies the fully-qualified name of the Java class that provides the Subject DN To User Attribute Certificate Mapper implementation.
ds-cfg-subject-attribute: string

Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN.
ds-cfg-user-base-dn(optional): array ds-cfg-user-base-dn

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-subject-attribute",
        "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 Subject DN To User Attribute Certificate Mapper implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.SubjectDNToUserAttributeCertificateMapper",
            "type":"string"
        },
        "ds-cfg-user-base-dn":{
            "description":"Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-subject-attribute":{
            "description":"Specifies the name or OID of the attribute whose value should exactly match the certificate subject DN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Certificate Mapper is enabled. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-user-base-dn

Type: array

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.

Show Source

Array of: string


{
    "description":"Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry. ",
    "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"
    }
}

204 Response

No content

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

Add, Search, Compare or Delete Subject DN To User Attribute Certificate Mapper

Request

Response

200 Response

201 Response

204 Response

406 Response