トラスト・ストア・ローカル・バックエンド・ワークフロー要素の追加、検索、比較または削除
POST
/rest/v1/admin
トラスト・ストア・ローカル・バックエンド・ワークフロー要素の追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるトラスト・ストア・ローカル・バックエンド・ワークフロー要素
ルート・スキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
- base(optional): string
LDAP検索操作に使用する検索ベースDN。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls(optional): array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn(optional): 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(optional): string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType: 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(optional): array requiredAttributes
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope(optional): string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-base-dn: array ds-cfg-base-dn
バックエンドが処理するデータのベースDNを指定します。
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement
トラスト・ストア・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-key-store-file(optional): string
デフォルト値:
config/ads-keystore
キーを格納するファイルへのパスを指定します。キー・ストア・タイプがファイルベース(PKCS11など)ではない場合、この値は必須ではありません。 - ds-cfg-key-store-pin(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
- ds-cfg-key-store-pin-environment-variable(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
- ds-cfg-key-store-pin-file(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
- ds-cfg-key-store-pin-file-encryption(optional): boolean
デフォルト値:
false
ファイルに書き込む前に、指定されたキー・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。 - ds-cfg-key-store-pin-property(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
- ds-cfg-key-store-type(optional): string
キー・ストア・ファイル内のデータの書式を指定します。
- ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
サーバーがリクエストを完了できない場合に返されるURL。
- ds-cfg-trust-store-file: string
デフォルト値:
config/ads-truststore
トラスト情報を格納するファイルのパスを指定します。 - ds-cfg-trust-store-pin(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
- ds-cfg-trust-store-pin-environment-variable(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
- ds-cfg-trust-store-pin-file(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
- ds-cfg-trust-store-pin-file-encryption(optional): boolean
デフォルト値:
false
ファイルに書き込む前に、指定されたトラスト・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。 - ds-cfg-trust-store-pin-property(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
- ds-cfg-trust-store-type(optional): string
キー・ストア・ファイル内のデータの書式を指定します。
- ds-cfg-writability-mode: string
デフォルト値:
enabled
指定可能な値:[ "disabled", "enabled", "internal-only" ]
バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSuccessResponse
型:
ソースを表示
object
- compareResult(optional): boolean
LDAP比較操作の結果を示します。
- msgType: 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: array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSearchResultEntry
型:
ソースを表示
object
- attributes: object トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-base-dn: array ds-cfg-base-dn
バックエンドが処理するデータのベースDNを指定します。
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement
トラスト・ストア・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-key-store-file(optional): string
デフォルト値:
config/ads-keystore
キーを格納するファイルへのパスを指定します。キー・ストア・タイプがファイルベース(PKCS11など)ではない場合、この値は必須ではありません。 - ds-cfg-key-store-pin(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
- ds-cfg-key-store-pin-environment-variable(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
- ds-cfg-key-store-pin-file(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
- ds-cfg-key-store-pin-file-encryption(optional): boolean
デフォルト値:
false
ファイルに書き込む前に、指定されたキー・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。 - ds-cfg-key-store-pin-property(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
- ds-cfg-key-store-type(optional): string
キー・ストア・ファイル内のデータの書式を指定します。
- ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
サーバーがリクエストを完了できない場合に返されるURL。
- ds-cfg-trust-store-file: string
デフォルト値:
config/ads-truststore
トラスト情報を格納するファイルのパスを指定します。 - ds-cfg-trust-store-pin(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
- ds-cfg-trust-store-pin-environment-variable(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
- ds-cfg-trust-store-pin-file(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
- ds-cfg-trust-store-pin-file-encryption(optional): boolean
デフォルト値:
false
ファイルに書き込む前に、指定されたトラスト・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。 - ds-cfg-trust-store-pin-property(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
- ds-cfg-trust-store-type(optional): string
キー・ストア・ファイル内のデータの書式を指定します。
- ds-cfg-writability-mode: string
デフォルト値:
enabled
指定可能な値:[ "disabled", "enabled", "internal-only" ]
バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
201レスポンス
作成済
ルート・スキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のADDResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のSearchResultEntry
型:
ソースを表示
object
- attributes: object トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: トラスト・ストア・ローカル・バックエンド・ワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-base-dn: array ds-cfg-base-dn
バックエンドが処理するデータのベースDNを指定します。
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.localbackend.TrustStoreLocalBackendWorkflowElement
トラスト・ストア・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-key-store-file(optional): string
デフォルト値:
config/ads-keystore
キーを格納するファイルへのパスを指定します。キー・ストア・タイプがファイルベース(PKCS11など)ではない場合、この値は必須ではありません。 - ds-cfg-key-store-pin(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
- ds-cfg-key-store-pin-environment-variable(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
- ds-cfg-key-store-pin-file(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
- ds-cfg-key-store-pin-file-encryption(optional): boolean
デフォルト値:
false
ファイルに書き込む前に、指定されたキー・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。 - ds-cfg-key-store-pin-property(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
- ds-cfg-key-store-type(optional): string
キー・ストア・ファイル内のデータの書式を指定します。
- ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
サーバーがリクエストを完了できない場合に返されるURL。
- ds-cfg-trust-store-file: string
デフォルト値:
config/ads-truststore
トラスト情報を格納するファイルのパスを指定します。 - ds-cfg-trust-store-pin(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを指定します。
- ds-cfg-trust-store-pin-environment-variable(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む環境変数の名前を指定します。
- ds-cfg-trust-store-pin-file(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含む1行のみが含まれるコンテンツのテキスト・ファイルのパスを指定します。
- ds-cfg-trust-store-pin-file-encryption(optional): boolean
デフォルト値:
false
ファイルに書き込む前に、指定されたトラスト・ストアのPINを暗号化する必要があるかどうかを示します。この属性は、PINがファイルに格納される場合にのみ有効です。 - ds-cfg-trust-store-pin-property(optional): string
トラスト・ストア・ローカル・バックエンド・ワークフロー要素へのアクセスに必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。
- ds-cfg-trust-store-type(optional): string
キー・ストア・ファイル内のデータの書式を指定します。
- ds-cfg-writability-mode: string
デフォルト値:
enabled
指定可能な値:[ "disabled", "enabled", "internal-only" ]
バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ