REST API for Oracle Unified Directory Administration

Modify a Trust Store Local Backend Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a Trust Store Local Backend Workflow Element by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Trust Store Local Backend Workflow Element 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 : Trust Store Local Backend Workflow Element 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/Trust Store Local Backend Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Trust Store Local Backend Workflow Element SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Trust Store Local Backend Workflow Element SearchResultEntry"
    }
}

Nested Schema : Trust Store Local Backend Workflow Element SearchResultEntry

Type: object

Show Source

attributes(required): object Trust Store Local Backend Workflow Element 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/Trust Store Local Backend Workflow Element Properties"
        }
    }
}

Nested Schema : Trust Store Local Backend Workflow Element Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-base-dn(required): array ds-cfg-base-dn

Specifies the base DN(s) for the data that the backend handles.
ds-cfg-enabled(required): boolean

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-java-class(required): string

Default Value: org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement

Specifies the fully-qualified name of the Java class that provides the Trust Store Local Backend Workflow Element implementation.
ds-cfg-key-store-file: string

Default Value: config/ads-keystore

Specifies the path to the file that stores the keys. If the key store type is not file based (like PKCS11), this value is not required.
ds-cfg-key-store-pin: string

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-pin-environment-variable: string

Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-pin-file: string

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-pin-file-encryption: boolean

Default Value: false

Indicates if the provided key store pin must be encrypted before writing in the file. This attribute is valid only if the pin is stored in a file.
ds-cfg-key-store-pin-property: string

Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-type: string

Specifies the format for the data in the key store file.
ds-cfg-referrals-url: array ds-cfg-referrals-url

The URLs that should be returned when the server is not able to fulfill the requests.
ds-cfg-trust-store-file(required): string

Default Value: config/ads-truststore

Specifies the path to the file that stores the trust information.
ds-cfg-trust-store-pin: string

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-pin-environment-variable: string

Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-pin-file: string

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-pin-file-encryption: boolean

Default Value: false

Indicates if the provided truststore pin must be encrypted before writing in the file. This attribute is valid only if the pin is stored in a file.
ds-cfg-trust-store-pin-property: string

Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-type: string

Specifies the format for the data in the key store file.
ds-cfg-writability-mode(required): string

Default Value: enabled

Allowed Values: [ "disabled", "enabled", "internal-only" ]

Specifies the behavior that the backend should use when processing write operations.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-writability-mode",
        "ds-cfg-base-dn",
        "ds-cfg-enabled",
        "ds-cfg-trust-store-file"
    ],
    "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 Trust Store Local Backend Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement",
            "type":"string"
        },
        "ds-cfg-trust-store-pin-property":{
            "description":"Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-store-pin":{
            "description":"Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-writability-mode":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"enabled",
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                "internal-only"
            ]
        },
        "ds-cfg-key-store-pin-environment-variable":{
            "description":"Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN(s) for the data that the backend handles. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-key-store-file":{
            "description":"Specifies the path to the file that stores the keys. If the key store type is not file based (like PKCS11), this value is not required. ",
            "readOnly":false,
            "default":"config/ads-keystore",
            "type":"string"
        },
        "ds-cfg-key-store-pin-file-encryption":{
            "description":"Indicates if the provided key store pin must be encrypted before writing in the file. This attribute is valid only if the pin is stored in a file. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-store-pin-property":{
            "description":"Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-type":{
            "description":"Specifies the format for the data in the key store file. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-trust-store-type":{
            "description":"Specifies the format for the data in the key store file. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-pin":{
            "description":"Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-trust-store-file":{
            "description":"Specifies the path to the file that stores the trust information. ",
            "readOnly":false,
            "default":"config/ads-truststore",
            "type":"string"
        },
        "ds-cfg-key-store-pin-file":{
            "description":"Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-trust-store-pin-environment-variable":{
            "description":"Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-trust-store-pin-file-encryption":{
            "description":"Indicates if the provided truststore pin must be encrypted before writing in the file. This attribute is valid only if the pin is stored in a file. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-trust-store-pin-file":{
            "description":"Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Local Backend Workflow Element . ",
            "readOnly":false,
            "type":"string"
        }
    }
}

Nested Schema : ds-cfg-base-dn

Type: array

Specifies the base DN(s) for the data that the backend handles.

Show Source

Array of: string

{
    "description":"Specifies the base DN(s) for the data that the backend handles. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-referrals-url

Type: array

The URLs that should be returned when the server is not able to fulfill the requests.

Show Source

Array of: string

{
    "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
    "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: 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."
        }
    }
}