Oracle Unified Directoryの管理REST API: LDAP接続ハンドラの追加、検索、比較または削除

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である場合)にのみ使用します。

{
    "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/LDAP Connection Handler 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"
        }
    }
}

ネストされたスキーマ: LDAP接続ハンドラのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-accept-backlog(optional): integer(int32)

デフォルト値: 128

受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。
ds-cfg-allow-ldap-v2(optional): boolean

デフォルト値: true

LDAPv2クライアントからの接続を許可するかどうかを示します。
ds-cfg-allow-start-tls(optional): boolean

デフォルト値: false

クライアントによるStartTLSの使用を許可するかどうかを示します。
ds-cfg-allow-tcp-reuse-address(optional): boolean

デフォルト値: true

LDAP接続ハンドラがソケット記述子を再利用するかどうかを示します。
ds-cfg-allowed-client(optional): array ds-cfg-allowed-client

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-buffer-size(optional): string

デフォルト値: 4096 bytes

LDAPレスポンス・メッセージ書込みバッファのサイズをバイト単位で指定します。
ds-cfg-denied-client(optional): array ds-cfg-denied-client

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-enabled: boolean

接続ハンドラが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.protocols.ldap.LDAPConnectionHandler

LDAP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-keep-stats(optional): boolean

デフォルト値: true

LDAP接続ハンドラが統計情報を保持するかどうかを示します。
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 minutes

LDAPクライアントへのデータの書込みの試行のブロックが許可される最長時間を指定します。
ds-cfg-max-request-size(optional): string

デフォルト値: 5 megabytes

LDAP接続ハンドラで許可される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

デフォルト値: false

LDAP接続ハンドラがSSLを使用するかどうかを示します。
ds-cfg-use-tcp-keep-alive(optional): boolean

デフォルト値: true

LDAP接続ハンドラがTCPキープアライブを使用するかどうかを示します。
ds-cfg-use-tcp-no-delay(optional): boolean

デフォルト値: true

LDAP接続ハンドラがTCP遅延なしを使用するかどうかを示します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-listen-port"
    ],
    "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 LDAP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.ldap.LDAPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-keep-stats":{
            "description":"Indicates whether the LDAP Connection Handler should keep statistics. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-allow-ldap-v2":{
            "description":"Indicates whether connections from LDAPv2 clients are allowed. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-no-delay":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP no-delay. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the size in bytes of the LDAP response message write buffer. ",
            "readOnly":false,
            "default":"4096 bytes",
            "type":"string"
        },
        "ds-cfg-send-rejection-notice":{
            "description":"Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-accept-backlog":{
            "description":"Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts. ",
            "readOnly":false,
            "default":128,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allow-tcp-reuse-address":{
            "description":"Indicates whether the LDAP Connection Handler should reuse socket descriptors. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the LDAP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the LDAP Connection Handler should use SSL. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-blocked-write-time-limit":{
            "description":"Specifies the maximum length of time that attempts to write data to LDAP clients should be allowed to block. ",
            "readOnly":false,
            "default":"2 minutes",
            "type":"string"
        },
        "ds-cfg-max-request-size":{
            "description":"Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler. ",
            "readOnly":false,
            "default":"5 megabytes",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-client-auth-policy":{
            "description":"Specifies the policy that the LDAP Connection Handler should use regarding client SSL certificates. ",
            "readOnly":false,
            "default":"optional",
            "type":"string",
            "enum":[
                "disabled",
                "optional",
                "required"
            ]
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allow-start-tls":{
            "description":"Indicates whether clients are allowed to use StartTLS. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-keep-alive":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP keep-alive. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the LDAP Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-num-request-handlers":{
            "description":"Specifies the number of request handlers that are used to read requests from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

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

ソースを表示

[0]: string

{
    "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である場合)にのみ使用します。

ソースを表示

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

ネストされたスキーマ: ds-cfg-allowed-client

型: array

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-denied-client

型: array

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-listen-address

型: array

LDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。

デフォルト値: [ "0.0.0.0" ]

ソースを表示

[0]: string

{
    "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
    "readOnly":false,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-cipher-suite

型: array

SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-protocol

型: array

SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: 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)

作成され、返されるエントリの数を指定します。

{
    "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/LDAP Connection Handler SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

[0]: object LDAP接続ハンドラのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/LDAP Connection Handler SearchResultEntry"
    }
}

ネストされたスキーマ: LDAP接続ハンドラのSearchResultEntry

型: object

ソースを表示

attributes: object LDAP接続ハンドラのプロパティ
dn: string

作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/LDAP Connection Handler Properties"
        }
    }
}

ネストされたスキーマ: LDAP接続ハンドラのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-accept-backlog(optional): integer(int32)

デフォルト値: 128

受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。
ds-cfg-allow-ldap-v2(optional): boolean

デフォルト値: true

LDAPv2クライアントからの接続を許可するかどうかを示します。
ds-cfg-allow-start-tls(optional): boolean

デフォルト値: false

クライアントによるStartTLSの使用を許可するかどうかを示します。
ds-cfg-allow-tcp-reuse-address(optional): boolean

デフォルト値: true

LDAP接続ハンドラがソケット記述子を再利用するかどうかを示します。
ds-cfg-allowed-client(optional): array ds-cfg-allowed-client

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-buffer-size(optional): string

デフォルト値: 4096 bytes

LDAPレスポンス・メッセージ書込みバッファのサイズをバイト単位で指定します。
ds-cfg-denied-client(optional): array ds-cfg-denied-client

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-enabled: boolean

接続ハンドラが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.protocols.ldap.LDAPConnectionHandler

LDAP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-keep-stats(optional): boolean

デフォルト値: true

LDAP接続ハンドラが統計情報を保持するかどうかを示します。
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 minutes

LDAPクライアントへのデータの書込みの試行のブロックが許可される最長時間を指定します。
ds-cfg-max-request-size(optional): string

デフォルト値: 5 megabytes

LDAP接続ハンドラで許可される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

デフォルト値: false

LDAP接続ハンドラがSSLを使用するかどうかを示します。
ds-cfg-use-tcp-keep-alive(optional): boolean

デフォルト値: true

LDAP接続ハンドラがTCPキープアライブを使用するかどうかを示します。
ds-cfg-use-tcp-no-delay(optional): boolean

デフォルト値: true

LDAP接続ハンドラがTCP遅延なしを使用するかどうかを示します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-listen-port"
    ],
    "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 LDAP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.ldap.LDAPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-keep-stats":{
            "description":"Indicates whether the LDAP Connection Handler should keep statistics. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-allow-ldap-v2":{
            "description":"Indicates whether connections from LDAPv2 clients are allowed. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-no-delay":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP no-delay. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the size in bytes of the LDAP response message write buffer. ",
            "readOnly":false,
            "default":"4096 bytes",
            "type":"string"
        },
        "ds-cfg-send-rejection-notice":{
            "description":"Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-accept-backlog":{
            "description":"Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts. ",
            "readOnly":false,
            "default":128,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allow-tcp-reuse-address":{
            "description":"Indicates whether the LDAP Connection Handler should reuse socket descriptors. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the LDAP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the LDAP Connection Handler should use SSL. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-blocked-write-time-limit":{
            "description":"Specifies the maximum length of time that attempts to write data to LDAP clients should be allowed to block. ",
            "readOnly":false,
            "default":"2 minutes",
            "type":"string"
        },
        "ds-cfg-max-request-size":{
            "description":"Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler. ",
            "readOnly":false,
            "default":"5 megabytes",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-client-auth-policy":{
            "description":"Specifies the policy that the LDAP Connection Handler should use regarding client SSL certificates. ",
            "readOnly":false,
            "default":"optional",
            "type":"string",
            "enum":[
                "disabled",
                "optional",
                "required"
            ]
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allow-start-tls":{
            "description":"Indicates whether clients are allowed to use StartTLS. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-keep-alive":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP keep-alive. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the LDAP Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-num-request-handlers":{
            "description":"Specifies the number of request handlers that are used to read requests from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-client

型: array

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-denied-client

型: array

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-listen-address

型: array

LDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。

デフォルト値: [ "0.0.0.0" ]

ソースを表示

[0]: string

{
    "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
    "readOnly":false,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-cipher-suite

型: array

SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-protocol

型: array

SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

201レスポンス

作成済

ルート・スキーマ: LDAP接続ハンドラのADDResponse

型: object

ソースを表示

msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

RESTメッセージ・タイプ
searchResultEntries: array searchResultEntries
totalResults: 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/LDAP Connection Handler SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object LDAP接続ハンドラのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LDAP Connection Handler SearchResultEntry"
    }
}

ネストされたスキーマ: LDAP接続ハンドラのSearchResultEntry

型: object

ソースを表示

attributes: object LDAP接続ハンドラのプロパティ
dn: string

作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/LDAP Connection Handler Properties"
        }
    }
}

ネストされたスキーマ: LDAP接続ハンドラのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-accept-backlog(optional): integer(int32)

デフォルト値: 128

受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。
ds-cfg-allow-ldap-v2(optional): boolean

デフォルト値: true

LDAPv2クライアントからの接続を許可するかどうかを示します。
ds-cfg-allow-start-tls(optional): boolean

デフォルト値: false

クライアントによるStartTLSの使用を許可するかどうかを示します。
ds-cfg-allow-tcp-reuse-address(optional): boolean

デフォルト値: true

LDAP接続ハンドラがソケット記述子を再利用するかどうかを示します。
ds-cfg-allowed-client(optional): array ds-cfg-allowed-client

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-buffer-size(optional): string

デフォルト値: 4096 bytes

LDAPレスポンス・メッセージ書込みバッファのサイズをバイト単位で指定します。
ds-cfg-denied-client(optional): array ds-cfg-denied-client

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-enabled: boolean

接続ハンドラが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.protocols.ldap.LDAPConnectionHandler

LDAP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-keep-stats(optional): boolean

デフォルト値: true

LDAP接続ハンドラが統計情報を保持するかどうかを示します。
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 minutes

LDAPクライアントへのデータの書込みの試行のブロックが許可される最長時間を指定します。
ds-cfg-max-request-size(optional): string

デフォルト値: 5 megabytes

LDAP接続ハンドラで許可される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

デフォルト値: false

LDAP接続ハンドラがSSLを使用するかどうかを示します。
ds-cfg-use-tcp-keep-alive(optional): boolean

デフォルト値: true

LDAP接続ハンドラがTCPキープアライブを使用するかどうかを示します。
ds-cfg-use-tcp-no-delay(optional): boolean

デフォルト値: true

LDAP接続ハンドラがTCP遅延なしを使用するかどうかを示します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-listen-port"
    ],
    "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 LDAP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.ldap.LDAPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-keep-stats":{
            "description":"Indicates whether the LDAP Connection Handler should keep statistics. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-allow-ldap-v2":{
            "description":"Indicates whether connections from LDAPv2 clients are allowed. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-no-delay":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP no-delay. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the size in bytes of the LDAP response message write buffer. ",
            "readOnly":false,
            "default":"4096 bytes",
            "type":"string"
        },
        "ds-cfg-send-rejection-notice":{
            "description":"Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-accept-backlog":{
            "description":"Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts. ",
            "readOnly":false,
            "default":128,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allow-tcp-reuse-address":{
            "description":"Indicates whether the LDAP Connection Handler should reuse socket descriptors. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the LDAP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the LDAP Connection Handler should use SSL. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-blocked-write-time-limit":{
            "description":"Specifies the maximum length of time that attempts to write data to LDAP clients should be allowed to block. ",
            "readOnly":false,
            "default":"2 minutes",
            "type":"string"
        },
        "ds-cfg-max-request-size":{
            "description":"Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler. ",
            "readOnly":false,
            "default":"5 megabytes",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-client-auth-policy":{
            "description":"Specifies the policy that the LDAP Connection Handler should use regarding client SSL certificates. ",
            "readOnly":false,
            "default":"optional",
            "type":"string",
            "enum":[
                "disabled",
                "optional",
                "required"
            ]
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allow-start-tls":{
            "description":"Indicates whether clients are allowed to use StartTLS. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-keep-alive":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP keep-alive. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the LDAP Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-num-request-handlers":{
            "description":"Specifies the number of request handlers that are used to read requests from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-client

型: array

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-denied-client

型: array

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-listen-address

型: array

LDAP接続ハンドラがLDAPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。

デフォルト値: [ "0.0.0.0" ]

ソースを表示

[0]: string

{
    "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
    "readOnly":false,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-cipher-suite

型: array

SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-protocol

型: array

SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

204レスポンス

コンテンツがありません

406レスポンス

受入れできません

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

ldapErrorCode(optional): integer(int32)

操作に対して返されるLDAPエラー・コードを指定します。
message: string

操作に対して返されるエラー・メッセージ。
msgType: 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."
        }
    }
}

先頭に戻る