Oracle Unified Directoryの管理REST API: 鍵マネージャ・プロバイダの鍵PINの追加、検索、比較または削除

鍵マネージャ・プロバイダの鍵PINの追加、検索、比較または削除

POST

/rest/v1/admin

鍵マネージャ・プロバイダの鍵PINの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要がある鍵マネージャ・プロバイダの鍵PIN

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

型: object

ソースを表示

assertion(optional): string

LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes(optional): object 鍵マネージャ・プロバイダの鍵PINのプロパティ
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/Key Manager Provider Key Pin 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"
        }
    }
}

ネストされたスキーマ: 鍵マネージャ・プロバイダの鍵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 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"
        }
    }
}

ネストされたスキーマ: 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"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: 鍵マネージャ・プロバイダの鍵PINの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/Key Manager Provider Key Pin SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

[0]: object 鍵マネージャ・プロバイダの鍵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: 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/Key Manager Provider 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 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

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

ソースを表示

[0]: string

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

201レスポンス

作成済

ルート・スキーマ: 鍵マネージャ・プロバイダの鍵PINの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/Key Manager Provider Key Pin SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object 鍵マネージャ・プロバイダの鍵PINのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Key Manager Provider 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/Key Manager Provider 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 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

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

ソースを表示

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

先頭に戻る