Admin REST APIs for Oracle Unified Directory

Add, Search, Compare or Delete Trust Store Local Backend Workflow Element

post

/rest/v1/admin

Add, Search, Compare or Delete Trust Store Local Backend Workflow Element

Request

Supported Media Types

application/json

Trust Store Local Backend Workflow Element that needs to be created

Root Schema : Trust Store Local Backend Workflow Element 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 Trust Store Local Backend Workflow Element 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/Trust Store Local Backend Workflow Element 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 : Trust Store Local Backend Workflow Element Properties

Type: object

Show Source

cn(optional): string

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

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

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-java-class: 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(optional): 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(optional): string

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-pin-environment-variable(optional): 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(optional): 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(optional): 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(optional): 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(optional): string

Specifies the format for the data in the key store file.
ds-cfg-referrals-url(optional): 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: string

Default Value: config/ads-truststore

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

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-pin-environment-variable(optional): 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(optional): 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(optional): 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(optional): 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(optional): string

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

Default Value: enabled

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

Specifies the behavior that the backend should use when processing write operations.
objectclass: 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 : controls

Type: array

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

Show Source

[0]: 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

[0]: 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-base-dn

Type: array

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

Show Source

[0]: 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

[0]: 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

[0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Trust Store Local Backend Workflow Element 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/Trust Store Local Backend Workflow Element 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

[0]: 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: object Trust Store Local Backend Workflow Element 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/Trust Store Local Backend Workflow Element Properties"
        }
    }
}

Nested Schema : Trust Store Local Backend Workflow Element Properties

Type: object

Show Source

cn(optional): string

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

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

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-java-class: 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(optional): 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(optional): string

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-pin-environment-variable(optional): 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(optional): 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(optional): 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(optional): 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(optional): string

Specifies the format for the data in the key store file.
ds-cfg-referrals-url(optional): 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: string

Default Value: config/ads-truststore

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

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-pin-environment-variable(optional): 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(optional): 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(optional): 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(optional): 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(optional): string

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

Default Value: enabled

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

Specifies the behavior that the backend should use when processing write operations.
objectclass: 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

[0]: 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

[0]: 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

[0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

201 Response

Created

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

Nested Schema : searchResultEntries

Type: array

Show Source

[0]: object Trust Store Local Backend Workflow Element SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Trust Store Local Backend Workflow Element SearchResultEntry"
    }
}

Nested Schema : Trust Store Local Backend Workflow Element SearchResultEntry

Type: object

Show Source

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

Nested Schema : Trust Store Local Backend Workflow Element Properties

Type: object

Show Source

cn(optional): string

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

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

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-java-class: 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(optional): 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(optional): string

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-key-store-pin-environment-variable(optional): 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(optional): 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(optional): 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(optional): 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(optional): string

Specifies the format for the data in the key store file.
ds-cfg-referrals-url(optional): 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: string

Default Value: config/ads-truststore

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

Specifies the clear-text PIN needed to access the Trust Store Local Backend Workflow Element .
ds-cfg-trust-store-pin-environment-variable(optional): 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(optional): 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(optional): 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(optional): 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(optional): string

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

Default Value: enabled

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

Specifies the behavior that the backend should use when processing write operations.
objectclass: 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

[0]: 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

[0]: 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

[0]: 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."
        }
    }
}