ジャンプ先

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

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/Data Encryption SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object データの暗号化のSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Data Encryption 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/Data Encryption Properties"
        }
    }
}

ネストされたスキーマ: データの暗号化のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-attribute-encryption-include(optional): array ds-cfg-attribute-encryption-include
  定義されたサフィクスの下にあるすべてのエントリ内で暗号化する属性を定義できます。
• ds-cfg-enabled(optional): boolean
  デフォルト値: false

  データ暗号化が有効化されているかどうかを示します。
• ds-cfg-encrypted-suffix(optional): array ds-cfg-encrypted-suffix
  暗号化を実行する必要があるサフィクスを定義できます。
• ds-cfg-encryption-algorithm(optional): string
  デフォルト値: aes-128

  指定可能な値: [ "aes-128", "aes-256", "blowfish-128", "rc4-128", "triple-des-168" ]

  属性の暗号化に使用されるアルゴリズム。
• 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-encrypted-suffix":{
            "description":"Allows to define the suffixes in which the encryption should occur. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-encryption-algorithm":{
            "description":"Algorithm used for attribute encryption. ",
            "readOnly":false,
            "default":"aes-128",
            "type":"string",
            "enum":[
                "aes-128",
                "aes-256",
                "blowfish-128",
                "rc4-128",
                "triple-des-168"
            ]
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Data Encryption is enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-attribute-encryption-include":{
            "description":"Allows to define some attributes to encrypt in all entries that are under the defined suffixes. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-attribute-encryption-include

型: array

定義されたサフィクスの下にあるすべてのエントリ内で暗号化する属性を定義できます。

ソースを表示

• [0]: string

{
    "description":"Allows to define some attributes to encrypt in all entries that are under the defined suffixes. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-encrypted-suffix

型: array

暗号化を実行する必要があるサフィクスを定義できます。

ソースを表示

• [0]: string

{
    "description":"Allows to define the suffixes in which the encryption should occur. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

先頭に戻る