ジャンプ先

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

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/Referential Integrity Plugin SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object 参照整合性プラグインのSearchResultEntry

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

ネストされたスキーマ: 参照整合性プラグインのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-attribute-type: array ds-cfg-attribute-type
  参照整合性が維持される属性タイプを指定します。
• ds-cfg-base-dn(optional): array ds-cfg-base-dn
  参照整合性が維持される範囲を制限するベースDNを指定します。
• ds-cfg-enabled: boolean
  このプラグインが使用可能かどうかを示します。
• ds-cfg-invoke-for-internal-operations(optional): boolean
  デフォルト値: true

  プラグインを内部操作のために呼び出す必要があるかどうかを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.plugins.ReferentialIntegrityPlugin

  プラグインの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-log-file(optional): string
  デフォルト値: logs/referint

  プラグインがバックグラウンドモード処理の場合に更新レコードが書き込まれるログ・ファイルの場所を指定します。
• ds-cfg-plugin-type: array ds-cfg-plugin-type
  プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。
• ds-cfg-update-interval(optional): string
  デフォルト値: 0 seconds

  参照整合性の更新が実行される間隔を秒単位で指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-plugin-type",
        "ds-cfg-attribute-type",
        "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":"Specifies the fully-qualified name of the Java class that provides the plug-in implementation. ",
            "readOnly":false,
            "default":"org.opends.server.plugins.ReferentialIntegrityPlugin",
            "type":"string"
        },
        "ds-cfg-invoke-for-internal-operations":{
            "description":"Indicates whether the plug-in should be invoked for internal operations. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-plugin-type":{
            "description":"Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. ",
            "readOnly":false,
            "default":[
                "postoperationdelete",
                "postoperationmodifydn",
                "subordinatemodifydn",
                "subordinatedelete"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "intermediateresponse",
                "ldifexport",
                "ldifimport",
                "ldifimportbegin",
                "ldifimportend",
                "postconnect",
                "postdisconnect",
                "postoperationabandon",
                "postoperationadd",
                "postoperationbind",
                "postoperationcompare",
                "postoperationdelete",
                "postoperationextended",
                "postoperationmodify",
                "postoperationmodifydn",
                "postoperationsearch",
                "postoperationunbind",
                "postresponseadd",
                "postresponsebind",
                "postresponsecompare",
                "postresponsedelete",
                "postresponseextended",
                "postresponsemodify",
                "postresponsemodifydn",
                "postresponsesearch",
                "postsynchronizationadd",
                "postsynchronizationdelete",
                "postsynchronizationmodify",
                "postsynchronizationmodifydn",
                "preoperationadd",
                "preoperationbind",
                "preoperationcompare",
                "preoperationdelete",
                "preoperationextended",
                "preoperationmodify",
                "preoperationmodifydn",
                "preoperationsearch",
                "preparseabandon",
                "preparseadd",
                "preparsebind",
                "preparsecompare",
                "preparsedelete",
                "preparseextended",
                "preparsemodify",
                "preparsemodifydn",
                "preparsesearch",
                "preparseunbind",
                "searchresultentry",
                "searchresultreference",
                "shutdown",
                "startup",
                "subordinatedelete",
                "subordinatemodifydn"
            ]
        },
        "ds-cfg-update-interval":{
            "description":"Specifies the interval in seconds when referential integrity updates are made. ",
            "readOnly":false,
            "default":"0 seconds",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"Specifies the log file location where the update records are written when the plug-in is in background-mode processing. ",
            "readOnly":false,
            "default":"logs/referint",
            "type":"string"
        },
        "ds-cfg-attribute-type":{
            "description":"Specifies the attribute types for which referential integrity is to be maintained. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN that limits the scope within which referential integrity is maintained. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the plug-in is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

型: array

参照整合性が維持される属性タイプを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the attribute types for which referential integrity is to be maintained. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-base-dn

型: array

参照整合性が維持される範囲を制限するベースDNを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the base DN that limits the scope within which referential integrity is maintained. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-plugin-type

型: array

プラグインが呼び出される回数を指定する、プラグインの一連のプラグイン・タイプを指定します。

デフォルト値: [ "postoperationdelete", "postoperationmodifydn", "subordinatemodifydn", "subordinatedelete" ]

指定可能な値: [ "intermediateresponse", "ldifexport", "ldifimport", "ldifimportbegin", "ldifimportend", "postconnect", "postdisconnect", "postoperationabandon", "postoperationadd", "postoperationbind", "postoperationcompare", "postoperationdelete", "postoperationextended", "postoperationmodify", "postoperationmodifydn", "postoperationsearch", "postoperationunbind", "postresponseadd", "postresponsebind", "postresponsecompare", "postresponsedelete", "postresponseextended", "postresponsemodify", "postresponsemodifydn", "postresponsesearch", "postsynchronizationadd", "postsynchronizationdelete", "postsynchronizationmodify", "postsynchronizationmodifydn", "preoperationadd", "preoperationbind", "preoperationcompare", "preoperationdelete", "preoperationextended", "preoperationmodify", "preoperationmodifydn", "preoperationsearch", "preparseabandon", "preparseadd", "preparsebind", "preparsecompare", "preparsedelete", "preparseextended", "preparsemodify", "preparsemodifydn", "preparsesearch", "preparseunbind", "searchresultentry", "searchresultreference", "shutdown", "startup", "subordinatedelete", "subordinatemodifydn" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked. ",
    "readOnly":false,
    "default":[
        "postoperationdelete",
        "postoperationmodifydn",
        "subordinatemodifydn",
        "subordinatedelete"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "intermediateresponse",
        "ldifexport",
        "ldifimport",
        "ldifimportbegin",
        "ldifimportend",
        "postconnect",
        "postdisconnect",
        "postoperationabandon",
        "postoperationadd",
        "postoperationbind",
        "postoperationcompare",
        "postoperationdelete",
        "postoperationextended",
        "postoperationmodify",
        "postoperationmodifydn",
        "postoperationsearch",
        "postoperationunbind",
        "postresponseadd",
        "postresponsebind",
        "postresponsecompare",
        "postresponsedelete",
        "postresponseextended",
        "postresponsemodify",
        "postresponsemodifydn",
        "postresponsesearch",
        "postsynchronizationadd",
        "postsynchronizationdelete",
        "postsynchronizationmodify",
        "postsynchronizationmodifydn",
        "preoperationadd",
        "preoperationbind",
        "preoperationcompare",
        "preoperationdelete",
        "preoperationextended",
        "preoperationmodify",
        "preoperationmodifydn",
        "preoperationsearch",
        "preparseabandon",
        "preparseadd",
        "preparsebind",
        "preparsecompare",
        "preparsedelete",
        "preparseextended",
        "preparsemodify",
        "preparsemodifydn",
        "preparsesearch",
        "preparseunbind",
        "searchresultentry",
        "searchresultreference",
        "shutdown",
        "startup",
        "subordinatedelete",
        "subordinatemodifydn"
    ]
}

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

先頭に戻る