ジャンプ先

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

DNによるファイル・ベース鍵マネージャ・プロバイダの変更

PATCH

/rest/v1/admin/{dn}

DNによるファイル・ベース鍵マネージャ・プロバイダの変更

リクエスト

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

• application/json

パス・パラメータ

• dn: string
  変更するエントリのLDAP DN。

本文 ()

変更する必要があるファイル・ベース鍵マネージャ・プロバイダ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls(optional): array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations: array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: string

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• [0]: object PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: object

ソースを表示

• attribute: string
  変更するエントリ属性。
• opType: string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values(optional): array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

• [0]: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: ファイル・ベース鍵マネージャ・プロバイダのPatchSuccessResponse

型: object

ソースを表示

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

  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:ModifyResponse",
            "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/File Based Key Manager Provider SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object ファイル・ベース鍵マネージャ・プロバイダのSearchResultEntry

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

ネストされたスキーマ: ファイル・ベース鍵マネージャ・プロバイダのSearchResultEntry

型: object

ソースを表示

• attributes: object ファイル・ベース鍵マネージャ・プロバイダのプロパティ
• 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/File Based Key Manager Provider Properties"
        }
    }
}

ネストされたスキーマ: ファイル・ベース鍵マネージャ・プロバイダのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-enabled: boolean
  鍵マネージャ・プロバイダの使用が有効かどうかを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.extensions.FileBasedKeyManagerProvider

  ファイル・ベース鍵マネージャ・プロバイダの実装を提供するJavaクラスの完全修飾名。
• ds-cfg-key-store-file: string
  秘密鍵情報を含むファイルのパスを指定します。絶対パスを指定することも、Oracle Unified Directoryインスタンス・ルートに対して相対的なパスを指定することもできます。
• ds-cfg-key-store-pin(optional): string
  ファイル・ベース鍵マネージャ・プロバイダへのアクセスに必要なクリア・テキストPINを指定します。
• ds-cfg-key-store-pin-environment-variable(optional): string
  ファイル・ベース鍵マネージャ・プロバイダへのアクセスに必要なクリア・テキストPINが格納された環境変数の名前を指定します。
• ds-cfg-key-store-pin-file(optional): string
  ファイル・ベース鍵マネージャ・プロバイダへのアクセスに必要なクリア・テキストPINを示す1行のコンテンツのみを含むテキスト・ファイルのパスを指定します。
• ds-cfg-key-store-pin-property(optional): string
  ファイル・ベース鍵マネージャ・プロバイダへのアクセスに必要なクリア・テキストPINが格納されたJavaプロパティの名前を指定します。
• ds-cfg-key-store-type(optional): string
  キー・ストア・ファイル内のデータの書式を指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-key-store-file",
        "ds-cfg-enabled"
    ],
    "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":"The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FileBasedKeyManagerProvider",
            "type":"string"
        },
        "ds-cfg-key-store-pin-property":{
            "description":"Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-type":{
            "description":"Specifies the format for the data in the key store file. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-pin-environment-variable":{
            "description":"Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-pin":{
            "description":"Specifies the clear-text PIN needed to access the File Based Key Manager Provider . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-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 File Based Key Manager Provider . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-store-file":{
            "description":"Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the Oracle Unified Directory instance root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Key Manager Provider is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

400レスポンス

ERROR

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

先頭に戻る