ジャンプ先

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

DNによるトラスト・ストアの鍵PINの検索

GET

/rest/v1/admin/{dn}

DNによってトラスト・ストアの鍵PINを返します

リクエスト

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

• 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

本文 ()

ルート・スキーマ: トラスト・ストアの鍵PINの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/Trust Store Key Pin SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object トラスト・ストアの鍵PINのSearchResultEntry

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

ネストされたスキーマ: トラスト・ストアの鍵PINのSearchResultEntry

型: object

ソースを表示

• attributes: object トラスト・ストアの鍵PINのプロパティ
• 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/Trust Store Key Pin Properties"
        }
    }
}

ネストされたスキーマ: トラスト・ストアの鍵PINのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-key-pin(optional): string
  鍵マネージャ・プロバイダが参照するキー・ストアの非公開鍵にアクセスするために必要なクリア・テキストPINを指定します。鍵PINプロパティが指定されていない場合、サーバーは鍵マネージャ・プロバイダのPINを使用して非公開鍵へのアクセスを試みます。サーバーはプロパティが定義されているかどうかを、Javaプロパティ、環境変数、ファイル、値の順にチェックします。最初に定義された値が使用されます。
• ds-cfg-key-pin-environment-variable(optional): string
  鍵マネージャ・プロバイダが参照するキー・ストアの非公開鍵にアクセスするために必要なクリア・テキストPINを含む環境変数の名前を指定します。非公開鍵PINプロパティが指定されていない場合、サーバーは鍵マネージャ・プロバイダのPINを使用して非公開鍵へのアクセスを試みます。
• ds-cfg-key-pin-file(optional): string
  唯一のコンテンツが、鍵マネージャ・プロバイダが参照するキー・ストアの非公開鍵にアクセスするために必要なクリア・テキストPINを含む単一行であるテキスト・ファイルへのパスを指定します。非公開鍵PINプロパティが指定されていない場合、サーバーは鍵マネージャ・プロバイダのPINを使用して非公開鍵へのアクセスを試みます。
• ds-cfg-key-pin-property(optional): string
  鍵マネージャ・プロバイダが参照するキー・ストアの非公開鍵にアクセスするために必要なクリア・テキストPINを含むJavaプロパティの名前を指定します。非公開鍵PINプロパティが指定されていない場合、サーバーは鍵マネージャ・プロバイダのPINを使用して非公開鍵へのアクセスを試みます。
• ds-cfg-ssl-cert-nickname(optional): string
  読取り専用: true

  このトラスト・ストアの鍵PINを適用する証明書のニックネームを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass"
    ],
    "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-key-pin":{
            "description":"Specifies the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. The server will check if the properties are defined in the following order: Java property, environment variable, file, value. The first defined value will be used . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-pin-property":{
            "description":"Specifies the name of the Java property that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname of the certificate this Trust Store Key Pin applies to. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-key-pin-environment-variable":{
            "description":"Specifies the name of the environment variable that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-pin-file":{
            "description":"Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN . ",
            "readOnly":false,
            "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."
        }
    }
}

先頭に戻る