LDAP接続ハンドラの追加、検索、比較または削除
POST
/rest/v1/admin
LDAP接続ハンドラの追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるLDAP接続ハンドラ
ルート・スキーマ: LDAP接続ハンドラのPOSTRequest
型:
ソースを表示
object- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object LDAP接続ハンドラのプロパティ
- 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である場合)にのみ使用します。
ネストされたスキーマ: LDAP接続ハンドラのプロパティ
型:
ソースを表示
object- cn(optional): string
エントリのCN (共通名)
- ds-cfg-accept-backlog(optional): integer(int32)
デフォルト値:
128受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。 - ds-cfg-allow-ldap-v2(optional): boolean
デフォルト値:
trueLDAPv2クライアントからの接続を許可するかどうかを示します。 - ds-cfg-allow-start-tls(optional): boolean
デフォルト値:
falseクライアントによるStartTLSの使用を許可するかどうかを示します。 - ds-cfg-allow-tcp-reuse-address(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがソケット記述子を再利用するかどうかを示します。 - ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-buffer-size(optional): string
デフォルト値:
4096 bytesLDAPレスポンス・メッセージ書込みバッファのサイズをバイト単位で指定します。 - ds-cfg-denied-client(optional): array ds-cfg-denied-client
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-enabled: boolean
接続ハンドラが使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.protocols.ldap.LDAPConnectionHandlerLDAP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-keep-stats(optional): boolean
デフォルト値:
trueLDAP接続ハンドラが統計情報を保持するかどうかを示します。 - ds-cfg-key-manager-provider(optional): string
このLDAP接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
- ds-cfg-listen-address(optional): array ds-cfg-listen-address
LDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
- ds-cfg-listen-port: integer(int32)
LDAP接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
- ds-cfg-max-blocked-write-time-limit(optional): string
デフォルト値:
2 minutesLDAPクライアントへのデータの書込みの試行のブロックが許可される最長時間を指定します。 - ds-cfg-max-request-size(optional): string
デフォルト値:
5 megabytesLDAP接続ハンドラで許可されるLDAPリクエスト・メッセージの最大サイズをバイト単位で指定します。 - ds-cfg-num-request-handlers(optional): integer(int32)
クライアントからのリクエストを読み取るために使用されるリクエスト・ハンドラの数を指定します。
- ds-cfg-send-rejection-notice(optional): boolean
デフォルト値:
trueなんらかの理由により新しい接続が拒否された場合に、LDAP接続ハンドラが切断拡張レスポンス・メッセージの通知をクライアントに送信するかどうかを示します。 - ds-cfg-ssl-cert-nickname(optional): string
LDAP接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
- ds-cfg-ssl-cipher-suite(optional): array ds-cfg-ssl-cipher-suite
SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。
- ds-cfg-ssl-client-auth-policy(optional): string
デフォルト値:
optional指定可能な値:[ "disabled", "optional", "required" ]クライアントSSL証明書に関してLDAP接続ハンドラが使用するポリシーを指定します。 - ds-cfg-ssl-protocol(optional): array ds-cfg-ssl-protocol
SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。
- ds-cfg-trust-manager-provider(optional): string
このLDAP接続ハンドラで使用する必要がある信頼マネージャの名前を指定します。
- ds-cfg-use-ssl(optional): boolean
デフォルト値:
falseLDAP接続ハンドラがSSLを使用するかどうかを示します。 - ds-cfg-use-tcp-keep-alive(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがTCPキープアライブを使用するかどうかを示します。 - ds-cfg-use-tcp-no-delay(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがTCP遅延なしを使用するかどうかを示します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
arrayエントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-allowed-client
型:
arrayこの接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-denied-client
型:
arrayこの接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-listen-address
型:
arrayLDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
デフォルト値:
ソースを表示
[ "0.0.0.0" ]レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: LDAP接続ハンドラの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)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: LDAP接続ハンドラのSearchResultEntry
型:
ソースを表示
object- attributes: object LDAP接続ハンドラのプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: LDAP接続ハンドラのプロパティ
型:
ソースを表示
object- cn(optional): string
エントリのCN (共通名)
- ds-cfg-accept-backlog(optional): integer(int32)
デフォルト値:
128受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。 - ds-cfg-allow-ldap-v2(optional): boolean
デフォルト値:
trueLDAPv2クライアントからの接続を許可するかどうかを示します。 - ds-cfg-allow-start-tls(optional): boolean
デフォルト値:
falseクライアントによるStartTLSの使用を許可するかどうかを示します。 - ds-cfg-allow-tcp-reuse-address(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがソケット記述子を再利用するかどうかを示します。 - ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-buffer-size(optional): string
デフォルト値:
4096 bytesLDAPレスポンス・メッセージ書込みバッファのサイズをバイト単位で指定します。 - ds-cfg-denied-client(optional): array ds-cfg-denied-client
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-enabled: boolean
接続ハンドラが使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.protocols.ldap.LDAPConnectionHandlerLDAP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-keep-stats(optional): boolean
デフォルト値:
trueLDAP接続ハンドラが統計情報を保持するかどうかを示します。 - ds-cfg-key-manager-provider(optional): string
このLDAP接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
- ds-cfg-listen-address(optional): array ds-cfg-listen-address
LDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
- ds-cfg-listen-port: integer(int32)
LDAP接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
- ds-cfg-max-blocked-write-time-limit(optional): string
デフォルト値:
2 minutesLDAPクライアントへのデータの書込みの試行のブロックが許可される最長時間を指定します。 - ds-cfg-max-request-size(optional): string
デフォルト値:
5 megabytesLDAP接続ハンドラで許可されるLDAPリクエスト・メッセージの最大サイズをバイト単位で指定します。 - ds-cfg-num-request-handlers(optional): integer(int32)
クライアントからのリクエストを読み取るために使用されるリクエスト・ハンドラの数を指定します。
- ds-cfg-send-rejection-notice(optional): boolean
デフォルト値:
trueなんらかの理由により新しい接続が拒否された場合に、LDAP接続ハンドラが切断拡張レスポンス・メッセージの通知をクライアントに送信するかどうかを示します。 - ds-cfg-ssl-cert-nickname(optional): string
LDAP接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
- ds-cfg-ssl-cipher-suite(optional): array ds-cfg-ssl-cipher-suite
SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。
- ds-cfg-ssl-client-auth-policy(optional): string
デフォルト値:
optional指定可能な値:[ "disabled", "optional", "required" ]クライアントSSL証明書に関してLDAP接続ハンドラが使用するポリシーを指定します。 - ds-cfg-ssl-protocol(optional): array ds-cfg-ssl-protocol
SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。
- ds-cfg-trust-manager-provider(optional): string
このLDAP接続ハンドラで使用する必要がある信頼マネージャの名前を指定します。
- ds-cfg-use-ssl(optional): boolean
デフォルト値:
falseLDAP接続ハンドラがSSLを使用するかどうかを示します。 - ds-cfg-use-tcp-keep-alive(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがTCPキープアライブを使用するかどうかを示します。 - ds-cfg-use-tcp-no-delay(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがTCP遅延なしを使用するかどうかを示します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-allowed-client
型:
arrayこの接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-denied-client
型:
arrayこの接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-listen-address
型:
arrayLDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
デフォルト値:
ソースを表示
[ "0.0.0.0" ]201レスポンス
作成済
ルート・スキーマ: LDAP接続ハンドラのADDResponse
型:
ソースを表示
object- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponseRESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: LDAP接続ハンドラのSearchResultEntry
型:
ソースを表示
object- attributes: object LDAP接続ハンドラのプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: LDAP接続ハンドラのプロパティ
型:
ソースを表示
object- cn(optional): string
エントリのCN (共通名)
- ds-cfg-accept-backlog(optional): integer(int32)
デフォルト値:
128受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。 - ds-cfg-allow-ldap-v2(optional): boolean
デフォルト値:
trueLDAPv2クライアントからの接続を許可するかどうかを示します。 - ds-cfg-allow-start-tls(optional): boolean
デフォルト値:
falseクライアントによるStartTLSの使用を許可するかどうかを示します。 - ds-cfg-allow-tcp-reuse-address(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがソケット記述子を再利用するかどうかを示します。 - ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-buffer-size(optional): string
デフォルト値:
4096 bytesLDAPレスポンス・メッセージ書込みバッファのサイズをバイト単位で指定します。 - ds-cfg-denied-client(optional): array ds-cfg-denied-client
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-enabled: boolean
接続ハンドラが使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.protocols.ldap.LDAPConnectionHandlerLDAP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-keep-stats(optional): boolean
デフォルト値:
trueLDAP接続ハンドラが統計情報を保持するかどうかを示します。 - ds-cfg-key-manager-provider(optional): string
このLDAP接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
- ds-cfg-listen-address(optional): array ds-cfg-listen-address
LDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
- ds-cfg-listen-port: integer(int32)
LDAP接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
- ds-cfg-max-blocked-write-time-limit(optional): string
デフォルト値:
2 minutesLDAPクライアントへのデータの書込みの試行のブロックが許可される最長時間を指定します。 - ds-cfg-max-request-size(optional): string
デフォルト値:
5 megabytesLDAP接続ハンドラで許可されるLDAPリクエスト・メッセージの最大サイズをバイト単位で指定します。 - ds-cfg-num-request-handlers(optional): integer(int32)
クライアントからのリクエストを読み取るために使用されるリクエスト・ハンドラの数を指定します。
- ds-cfg-send-rejection-notice(optional): boolean
デフォルト値:
trueなんらかの理由により新しい接続が拒否された場合に、LDAP接続ハンドラが切断拡張レスポンス・メッセージの通知をクライアントに送信するかどうかを示します。 - ds-cfg-ssl-cert-nickname(optional): string
LDAP接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
- ds-cfg-ssl-cipher-suite(optional): array ds-cfg-ssl-cipher-suite
SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。
- ds-cfg-ssl-client-auth-policy(optional): string
デフォルト値:
optional指定可能な値:[ "disabled", "optional", "required" ]クライアントSSL証明書に関してLDAP接続ハンドラが使用するポリシーを指定します。 - ds-cfg-ssl-protocol(optional): array ds-cfg-ssl-protocol
SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。
- ds-cfg-trust-manager-provider(optional): string
このLDAP接続ハンドラで使用する必要がある信頼マネージャの名前を指定します。
- ds-cfg-use-ssl(optional): boolean
デフォルト値:
falseLDAP接続ハンドラがSSLを使用するかどうかを示します。 - ds-cfg-use-tcp-keep-alive(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがTCPキープアライブを使用するかどうかを示します。 - ds-cfg-use-tcp-no-delay(optional): boolean
デフォルト値:
trueLDAP接続ハンドラがTCP遅延なしを使用するかどうかを示します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-allowed-client
型:
arrayこの接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-denied-client
型:
arrayこの接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-listen-address
型:
arrayLDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
デフォルト値:
ソースを表示
[ "0.0.0.0" ]204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponseRESTメッセージ・タイプ