ジャンプ先

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

DNによるキー・マネージャ・プロバイダのキーPINの検索

GET

/rest/v1/admin/{dn}

DNによってキー・マネージャ・プロバイダのキーPINを返します

リクエスト

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

• application/json

パス・パラメータ

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

問合せパラメータ

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

  エントリに対してフェッチする属性のリスト。
• controls: array[string]
  コレクション形式: multi

  検索操作のためにサーバーに送信するLDAP制御。
• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: キー・マネージャ・プロバイダのキーPINのGetSuccessResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• 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: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/Key Manager Provider Key Pin SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト キー・マネージャ・プロバイダのキーPINのSearchResultEntry

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

ネストされたスキーマ: キー・マネージャ・プロバイダのキーPINのSearchResultEntry

型: object

ソースを表示

• attributes(required): object キー・マネージャ・プロバイダのキーPINのプロパティ
• 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/Key Manager Provider Key Pin Properties"
        }
    }
}

ネストされたスキーマ: キー・マネージャ・プロバイダのキーPINのプロパティ

型: object

ソースを表示

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

  キー・マネージャ・プロバイダのキーPINを適用する証明書のニックネームを指定します。
• objectclass(required): 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 Key Manager Provider 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

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

ソースを表示

• 配列: 文字列

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

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

先頭に戻る