7ビット・クリーン・プラグインの追加、検索、比較または削除
POST
/rest/v1/admin
7ビット・クリーン・プラグインの追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要がある7ビット・クリーン・プラグイン
ルート・スキーマ: 7ビット・クリーン・プラグインのPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object 7ビット・クリーン・プラグインのプロパティ
- 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である場合)にのみ使用します。
ネストされたスキーマ: 7ビット・クリーン・プラグインのプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-attribute-type: array ds-cfg-attribute-type
値を検査して、値が必ず7ビット・クリーン・モードになるようにする属性タイプの名前またはOIDを指定します。
- ds-cfg-base-dn(optional): array ds-cfg-base-dn
検査を実行する際に使用するベースDNを指定します。
- ds-cfg-enabled: boolean
このプラグインが使用可能かどうかを示します。
- ds-cfg-invoke-for-internal-operations(optional): boolean
デフォルト値:
true
プラグインを内部操作のために呼び出す必要があるかどうかを示します。 - ds-cfg-java-class: string
デフォルト値:
org.opends.server.plugins.SevenBitCleanPlugin
プラグインの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-plugin-type: array ds-cfg-plugin-type
プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-attribute-type
型:
array
値を検査して、値が必ず7ビット・クリーン・モードになるようにする属性タイプの名前またはOIDを指定します。
デフォルト値:
ソースを表示
[ "uid", "mail", "userPassword" ]
ネストされたスキーマ: ds-cfg-plugin-type
型:
array
プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
デフォルト値:
[ "ldifimport", "preparseadd", "preparsemodify", "preparsemodifydn" ]
指定可能な値:
ソースを表示
[ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: 7ビット・クリーン・プラグインの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)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: 7ビット・クリーン・プラグインのSearchResultEntry
型:
ソースを表示
object
- attributes: object 7ビット・クリーン・プラグインのプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: 7ビット・クリーン・プラグインのプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-attribute-type: array ds-cfg-attribute-type
値を検査して、値が必ず7ビット・クリーン・モードになるようにする属性タイプの名前またはOIDを指定します。
- ds-cfg-base-dn(optional): array ds-cfg-base-dn
検査を実行する際に使用するベースDNを指定します。
- ds-cfg-enabled: boolean
このプラグインが使用可能かどうかを示します。
- ds-cfg-invoke-for-internal-operations(optional): boolean
デフォルト値:
true
プラグインを内部操作のために呼び出す必要があるかどうかを示します。 - ds-cfg-java-class: string
デフォルト値:
org.opends.server.plugins.SevenBitCleanPlugin
プラグインの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-plugin-type: array ds-cfg-plugin-type
プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-attribute-type
型:
array
値を検査して、値が必ず7ビット・クリーン・モードになるようにする属性タイプの名前またはOIDを指定します。
デフォルト値:
ソースを表示
[ "uid", "mail", "userPassword" ]
ネストされたスキーマ: ds-cfg-plugin-type
型:
array
プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
デフォルト値:
[ "ldifimport", "preparseadd", "preparsemodify", "preparsemodifydn" ]
指定可能な値:
ソースを表示
[ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]
201レスポンス
作成済
ルート・スキーマ: 7ビット・クリーン・プラグインのADDResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: 7ビット・クリーン・プラグインのSearchResultEntry
型:
ソースを表示
object
- attributes: object 7ビット・クリーン・プラグインのプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: 7ビット・クリーン・プラグインのプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-attribute-type: array ds-cfg-attribute-type
値を検査して、値が必ず7ビット・クリーン・モードになるようにする属性タイプの名前またはOIDを指定します。
- ds-cfg-base-dn(optional): array ds-cfg-base-dn
検査を実行する際に使用するベースDNを指定します。
- ds-cfg-enabled: boolean
このプラグインが使用可能かどうかを示します。
- ds-cfg-invoke-for-internal-operations(optional): boolean
デフォルト値:
true
プラグインを内部操作のために呼び出す必要があるかどうかを示します。 - ds-cfg-java-class: string
デフォルト値:
org.opends.server.plugins.SevenBitCleanPlugin
プラグインの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-plugin-type: array ds-cfg-plugin-type
プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-attribute-type
型:
array
値を検査して、値が必ず7ビット・クリーン・モードになるようにする属性タイプの名前またはOIDを指定します。
デフォルト値:
ソースを表示
[ "uid", "mail", "userPassword" ]
ネストされたスキーマ: ds-cfg-plugin-type
型:
array
プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
デフォルト値:
[ "ldifimport", "preparseadd", "preparsemodify", "preparsemodifydn" ]
指定可能な値:
ソースを表示
[ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ