Oracle Unified Directory管理REST API

HTTP管理コネクタの追加、検索、比較または削除

POST

/rest/v1/admin

HTTP管理コネクタの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要があるHTTP管理コネクタ

ルート・スキーマ: HTTP管理コネクタのPOSTRequest

型: object

ソースを表示

assertion: string

LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes: object HTTP管理コネクタのプロパティ
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/HTTP Administration Connector 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"
        }
    }
}

ネストされたスキーマ: HTTP管理コネクタのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-dos-filter-max-requests-per-sec: integer(int32)

デフォルト値: 25

1つの接続の最大リクエスト数/秒を指定します。
ds-cfg-dos-filter-throttled-requests: integer(int32)

デフォルト値: 5

一度に考慮可能なレート制限を超えるリクエスト数。
ds-cfg-enabled(required): boolean

管理コネクタが使用可能かどうかを示します。
ds-cfg-java-class(required): string

デフォルト値: org.opends.server.admin.HTTPAdministrationConnector

HTTP管理コネクタの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-key-manager-provider(required): string

管理コネクタと併用するキー・マネージャの名前を指定します。
ds-cfg-listen-address: array ds-cfg-listen-address

この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。
ds-cfg-listen-port(required): integer(int32)

管理コネクタがクライアントからの接続をリスニングするポート番号を指定します。
ds-cfg-ssl-cert-nickname(required): string

管理コネクタがSSL通信の実行時に使用する証明書のニックネーム(別名とも呼ばれる)を指定します。
ds-cfg-ssl-cipher-suite: array ds-cfg-ssl-cipher-suite

SSL通信で使用できるSSL暗号化スイートの名前を指定します。
ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol

SSL通信で使用できるSSLプロトコルの名前を指定します。
ds-cfg-trust-manager-provider(required): string

管理コネクタと併用する信頼マネージャの名前を指定します。
objectclass(required): array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-trust-manager-provider",
        "ds-cfg-ssl-cert-nickname",
        "ds-cfg-listen-port",
        "ds-cfg-enabled",
        "ds-cfg-key-manager-provider"
    ],
    "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 HTTP Administration Connector implementation. ",
            "readOnly":false,
            "default":"org.opends.server.admin.HTTPAdministrationConnector",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dos-filter-max-requests-per-sec":{
            "description":"Specifies the maximum number of requests from a connection per second. ",
            "readOnly":false,
            "default":"25",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the Administration Connector will use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dos-filter-throttled-requests":{
            "description":"Number of requests over the rate limit able to be considered at once. ",
            "readOnly":false,
            "default":"5",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the Administration Connector will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Administration Connector is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "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-listen-address

型: array

この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
    "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レスポンス

ルート・スキーマ: HTTP管理コネクタの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/HTTP Administration Connector SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

配列: オブジェクト HTTP管理コネクタのSearchResultEntry

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

ネストされたスキーマ: HTTP管理コネクタのSearchResultEntry

型: object

ソースを表示

attributes(required): object HTTP管理コネクタのプロパティ
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/HTTP Administration Connector Properties"
        }
    }
}

ネストされたスキーマ: HTTP管理コネクタのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-dos-filter-max-requests-per-sec: integer(int32)

デフォルト値: 25

1つの接続の最大リクエスト数/秒を指定します。
ds-cfg-dos-filter-throttled-requests: integer(int32)

デフォルト値: 5

一度に考慮可能なレート制限を超えるリクエスト数。
ds-cfg-enabled(required): boolean

管理コネクタが使用可能かどうかを示します。
ds-cfg-java-class(required): string

デフォルト値: org.opends.server.admin.HTTPAdministrationConnector

HTTP管理コネクタの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-key-manager-provider(required): string

管理コネクタと併用するキー・マネージャの名前を指定します。
ds-cfg-listen-address: array ds-cfg-listen-address

この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。
ds-cfg-listen-port(required): integer(int32)

管理コネクタがクライアントからの接続をリスニングするポート番号を指定します。
ds-cfg-ssl-cert-nickname(required): string

管理コネクタがSSL通信の実行時に使用する証明書のニックネーム(別名とも呼ばれる)を指定します。
ds-cfg-ssl-cipher-suite: array ds-cfg-ssl-cipher-suite

SSL通信で使用できるSSL暗号化スイートの名前を指定します。
ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol

SSL通信で使用できるSSLプロトコルの名前を指定します。
ds-cfg-trust-manager-provider(required): string

管理コネクタと併用する信頼マネージャの名前を指定します。
objectclass(required): array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-trust-manager-provider",
        "ds-cfg-ssl-cert-nickname",
        "ds-cfg-listen-port",
        "ds-cfg-enabled",
        "ds-cfg-key-manager-provider"
    ],
    "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 HTTP Administration Connector implementation. ",
            "readOnly":false,
            "default":"org.opends.server.admin.HTTPAdministrationConnector",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dos-filter-max-requests-per-sec":{
            "description":"Specifies the maximum number of requests from a connection per second. ",
            "readOnly":false,
            "default":"25",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the Administration Connector will use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dos-filter-throttled-requests":{
            "description":"Number of requests over the rate limit able to be considered at once. ",
            "readOnly":false,
            "default":"5",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the Administration Connector will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Administration Connector is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

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

201レスポンス

作成済

ルート・スキーマ: HTTP管理コネクタの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/HTTP Administration Connector SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

配列: オブジェクト HTTP管理コネクタのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HTTP Administration Connector SearchResultEntry"
    }
}

ネストされたスキーマ: HTTP管理コネクタのSearchResultEntry

型: object

ソースを表示

attributes(required): object HTTP管理コネクタのプロパティ
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/HTTP Administration Connector Properties"
        }
    }
}

ネストされたスキーマ: HTTP管理コネクタのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-dos-filter-max-requests-per-sec: integer(int32)

デフォルト値: 25

1つの接続の最大リクエスト数/秒を指定します。
ds-cfg-dos-filter-throttled-requests: integer(int32)

デフォルト値: 5

一度に考慮可能なレート制限を超えるリクエスト数。
ds-cfg-enabled(required): boolean

管理コネクタが使用可能かどうかを示します。
ds-cfg-java-class(required): string

デフォルト値: org.opends.server.admin.HTTPAdministrationConnector

HTTP管理コネクタの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-key-manager-provider(required): string

管理コネクタと併用するキー・マネージャの名前を指定します。
ds-cfg-listen-address: array ds-cfg-listen-address

この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。
ds-cfg-listen-port(required): integer(int32)

管理コネクタがクライアントからの接続をリスニングするポート番号を指定します。
ds-cfg-ssl-cert-nickname(required): string

管理コネクタがSSL通信の実行時に使用する証明書のニックネーム(別名とも呼ばれる)を指定します。
ds-cfg-ssl-cipher-suite: array ds-cfg-ssl-cipher-suite

SSL通信で使用できるSSL暗号化スイートの名前を指定します。
ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol

SSL通信で使用できるSSLプロトコルの名前を指定します。
ds-cfg-trust-manager-provider(required): string

管理コネクタと併用する信頼マネージャの名前を指定します。
objectclass(required): array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-trust-manager-provider",
        "ds-cfg-ssl-cert-nickname",
        "ds-cfg-listen-port",
        "ds-cfg-enabled",
        "ds-cfg-key-manager-provider"
    ],
    "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 HTTP Administration Connector implementation. ",
            "readOnly":false,
            "default":"org.opends.server.admin.HTTPAdministrationConnector",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dos-filter-max-requests-per-sec":{
            "description":"Specifies the maximum number of requests from a connection per second. ",
            "readOnly":false,
            "default":"25",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the Administration Connector will use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dos-filter-throttled-requests":{
            "description":"Number of requests over the rate limit able to be considered at once. ",
            "readOnly":false,
            "default":"5",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the Administration Connector will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Administration Connector is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

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

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

型: array

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

ソースを表示

配列: 文字列

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
    "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."
        }
    }
}

先頭に戻る