ジャンプ先

• リクエスト
• レスポンス

トラスト・ストア・ローカル・バックエンド・ワークフロー要素の追加、検索、比較または削除

POST

/rest/v1/admin

トラスト・ストア・ローカル・バックエンド・ワークフロー要素の追加、検索、比較または削除

リクエスト

サポートされているメディア・タイプ

• application/json

本文 ()

作成する必要があるトラスト・ストア・ローカル・バックエンド・ワークフロー要素

ルート・スキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のPOSTRequest

型: object

ソースを表示

• assertion: string
  LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
• attributes: object トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
• base: string
  LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
• controls: array controls
  LDAP操作のためにサーバーに送信するLDAP制御。
• dn: string
  作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• msgType(required): string
  指定可能な値: [ "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" ]

  RESTメッセージ・タイプ
• requiredAttributes: array requiredAttributes
  エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• scope: string
  指定可能な値: [ "base", "sub", "one" ]

  LDAP検索操作の範囲。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeが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"
        }
    }
}

ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-base-dn(required): array ds-cfg-base-dn
  バックエンドが処理するデータのベースDNを指定します。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement

  トラスト・ストア・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-key-store-file: string
  デフォルト値: config/ads-keystore

  キーを格納するファイルへのパスを指定します。キー・ストア・タイプがファイルベース(PKCS11など)ではない場合、この値は必須ではありません。
• ds-cfg-key-store-pin: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-key-store-pin-environment-variable: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
• ds-cfg-key-store-pin-file: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
• ds-cfg-key-store-pin-file-encryption: boolean
  デフォルト値: false

  ファイルに書き込む前に、指定されたキー・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。
• ds-cfg-key-store-pin-property: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
• ds-cfg-key-store-type: string
  キー・ストア・ファイル内のデータの書式を指定します。
• ds-cfg-referrals-url: array ds-cfg-referrals-url
  サーバーがリクエストを完了できない場合に返されるURL。
• ds-cfg-trust-store-file(required): string
  デフォルト値: config/ads-truststore

  トラスト情報を格納するファイルのパスを指定します。
• ds-cfg-trust-store-pin: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-trust-store-pin-environment-variable: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
• ds-cfg-trust-store-pin-file: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
• ds-cfg-trust-store-pin-file-encryption: boolean
  デフォルト値: false

  ファイルに書き込む前に、指定されたトラスト・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。
• ds-cfg-trust-store-pin-property: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
• ds-cfg-trust-store-type: string
  キー・ストア・ファイル内のデータの書式を指定します。
• ds-cfg-writability-mode(required): string
  デフォルト値: enabled

  指定可能な値: [ "disabled", "enabled", "internal-only" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

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

ネストされたスキーマ: controls

型: array

LDAP操作のためにサーバーに送信するLDAP制御。

ソースを表示

• 配列: 文字列

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

ネストされたスキーマ: requiredAttributes

型: array

エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

ソースを表示

• 配列: 文字列

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

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

• 配列: 文字列

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

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返される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"
    }
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

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

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSuccessResponse

型: object

ソースを表示

• compareResult: boolean
  LDAP比較操作の結果を示します。
• msgType(required): string
  指定可能な値: [ "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" ]

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): integer(int32)
  作成され、返されるエントリの数を指定します。

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

ネストされたスキーマ: searchResultEntries

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• 配列: オブジェクト トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes(required): object トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

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

ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-base-dn(required): array ds-cfg-base-dn
  バックエンドが処理するデータのベースDNを指定します。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement

  トラスト・ストア・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-key-store-file: string
  デフォルト値: config/ads-keystore

  キーを格納するファイルへのパスを指定します。キー・ストア・タイプがファイルベース(PKCS11など)ではない場合、この値は必須ではありません。
• ds-cfg-key-store-pin: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-key-store-pin-environment-variable: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
• ds-cfg-key-store-pin-file: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
• ds-cfg-key-store-pin-file-encryption: boolean
  デフォルト値: false

  ファイルに書き込む前に、指定されたキー・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。
• ds-cfg-key-store-pin-property: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
• ds-cfg-key-store-type: string
  キー・ストア・ファイル内のデータの書式を指定します。
• ds-cfg-referrals-url: array ds-cfg-referrals-url
  サーバーがリクエストを完了できない場合に返されるURL。
• ds-cfg-trust-store-file(required): string
  デフォルト値: config/ads-truststore

  トラスト情報を格納するファイルのパスを指定します。
• ds-cfg-trust-store-pin: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-trust-store-pin-environment-variable: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
• ds-cfg-trust-store-pin-file: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
• ds-cfg-trust-store-pin-file-encryption: boolean
  デフォルト値: false

  ファイルに書き込む前に、指定されたトラスト・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。
• ds-cfg-trust-store-pin-property: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
• ds-cfg-trust-store-type: string
  キー・ストア・ファイル内のデータの書式を指定します。
• ds-cfg-writability-mode(required): string
  デフォルト値: enabled

  指定可能な値: [ "disabled", "enabled", "internal-only" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

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

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

• 配列: 文字列

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

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返される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"
    }
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

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

201レスポンス

作成済

本文 ()

ルート・スキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のADDResponse

型: object

ソースを表示

• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
• totalResults(required): integer(int32)
  作成され、返されるエントリの数を指定します。

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

ネストされたスキーマ: searchResultEntries

型: array

ソースを表示

• 配列: オブジェクト トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes(required): object トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

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

ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-base-dn(required): array ds-cfg-base-dn
  バックエンドが処理するデータのベースDNを指定します。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement

  トラスト・ストア・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-key-store-file: string
  デフォルト値: config/ads-keystore

  キーを格納するファイルへのパスを指定します。キー・ストア・タイプがファイルベース(PKCS11など)ではない場合、この値は必須ではありません。
• ds-cfg-key-store-pin: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-key-store-pin-environment-variable: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
• ds-cfg-key-store-pin-file: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
• ds-cfg-key-store-pin-file-encryption: boolean
  デフォルト値: false

  ファイルに書き込む前に、指定されたキー・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。
• ds-cfg-key-store-pin-property: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
• ds-cfg-key-store-type: string
  キー・ストア・ファイル内のデータの書式を指定します。
• ds-cfg-referrals-url: array ds-cfg-referrals-url
  サーバーがリクエストを完了できない場合に返されるURL。
• ds-cfg-trust-store-file(required): string
  デフォルト値: config/ads-truststore

  トラスト情報を格納するファイルのパスを指定します。
• ds-cfg-trust-store-pin: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-trust-store-pin-environment-variable: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
• ds-cfg-trust-store-pin-file: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
• ds-cfg-trust-store-pin-file-encryption: boolean
  デフォルト値: false

  ファイルに書き込む前に、指定されたトラスト・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。
• ds-cfg-trust-store-pin-property: string
  トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
• ds-cfg-trust-store-type: string
  キー・ストア・ファイル内のデータの書式を指定します。
• ds-cfg-writability-mode(required): string
  デフォルト値: enabled

  指定可能な値: [ "disabled", "enabled", "internal-only" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

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

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

• 配列: 文字列

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

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返される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"
    }
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

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

204レスポンス

コンテンツがありません

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

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

先頭に戻る