ジャンプ先

• リクエスト
• レスポンス

DNによるHTTP管理コネクタの検索

GET

/rest/v1/admin/{dn}

DNによってHTTP管理コネクタを返します

リクエスト

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

• application/json

パス・パラメータ

• dn: string
  フェッチするエントリのLDAP DN。

問合せパラメータ

• attributes: array
  コレクション形式: multi

  エントリに対してフェッチする属性のリスト。

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  コレクション形式: multi

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

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

  指定可能な値: [ "base", "sub", "one" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

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

型: object

ソースを表示

• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• 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:SearchResponse",
            "type":"string"
        },
        "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"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object 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: object HTTP管理コネクタのプロパティ
• 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/HTTP Administration Connector Properties"
        }
    }
}

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

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-dos-filter-max-requests-per-sec(optional): integer(int32)
  デフォルト値: 25

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

  一度に考慮可能なレート制限を超えるリクエスト数。
• ds-cfg-enabled: boolean
  管理コネクタが使用可能かどうかを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.admin.HTTPAdministrationConnector

  HTTP管理コネクタの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-key-manager-provider: string
  管理コネクタと併用する鍵マネージャの名前を指定します。
• ds-cfg-listen-address(optional): array ds-cfg-listen-address
  この管理コネクタがLDAPまたはHTTPクライアントからの接続をリスニングする、アドレスや一連のアドレスを指定します。
• ds-cfg-listen-port: integer(int32)
  管理コネクタがクライアントからの接続をリスニングするポート番号を指定します。
• ds-cfg-ssl-cert-nickname: string
  管理コネクタがSSL通信の実行時に使用する証明書のニックネーム(別名とも呼ばれる)を指定します。
• ds-cfg-ssl-cipher-suite(optional): array ds-cfg-ssl-cipher-suite
  SSL通信で使用できるSSL暗号化スイートの名前を指定します。
• ds-cfg-ssl-protocol(optional): array ds-cfg-ssl-protocol
  SSL通信で使用できるSSLプロトコルの名前を指定します。
• ds-cfg-trust-manager-provider: string
  管理コネクタと併用する信頼マネージャの名前を指定します。
• objectclass: 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" ]

ソースを表示

• [0]: string

{
    "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暗号化スイートの名前を指定します。

ソースを表示

• [0]: string

{
    "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プロトコルの名前を指定します。

ソースを表示

• [0]: string

{
    "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

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

ソースを表示

• [0]: string

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

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

先頭に戻る