ジャンプ先

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

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/Union Partition SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object 結合パーティションのSearchResultEntry

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

ネストされたスキーマ: 結合パーティションのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-allowed-operations(optional): array ds-cfg-allowed-operations
  このパーティションで許可される操作タイプ。
• ds-cfg-black-list-attributes(optional): array ds-cfg-black-list-attributes
  変換が許可されないDN構文の属性のリスト。
• ds-cfg-priority(optional): integer(int32)
  デフォルト値: 10

  パーティションの優先度。
• ds-cfg-relative-base-dn(optional): string
  デフォルト値:

  パーティション・ベースDNの相対部分。
• ds-cfg-source-base-dn(optional): string
  デフォルト値:

  ソースDITのベースDN。
• ds-cfg-white-list-attributes(optional): array ds-cfg-white-list-attributes
  変換する必要があるDN構文の属性のリスト。
• ds-cfg-workflow-element: string
  パーティション・ワークフロー要素。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element"
    ],
    "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-white-list-attributes":{
            "description":"The list of attributes of DN syntax that must be transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-source-base-dn":{
            "description":"The base DN for the source DIT. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-workflow-element":{
            "description":"The partition workflow element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-relative-base-dn":{
            "description":"The relative part of the partition base DN. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"The priority of the partition. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allowed-operations":{
            "description":"The operation types allowed in this partition. ",
            "readOnly":false,
            "default":[
                "search",
                "bind",
                "add",
                "delete",
                "modify",
                "modifyDN",
                "compare",
                "extended"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-black-list-attributes":{
            "description":"The list of attributes of DN syntax that must NOT be transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-operations

型: array

このパーティションで許可される操作タイプ。

デフォルト値: [ "search", "bind", "add", "delete", "modify", "modifyDN", "compare", "extended" ]

指定可能な値: [ "add", "bind", "compare", "delete", "extended", "modify", "modifydn", "search" ]

ソースを表示

• [0]: string

{
    "description":"The operation types allowed in this partition. ",
    "readOnly":false,
    "default":[
        "search",
        "bind",
        "add",
        "delete",
        "modify",
        "modifyDN",
        "compare",
        "extended"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

ネストされたスキーマ: ds-cfg-black-list-attributes

型: array

変換が許可されないDN構文の属性のリスト。

ソースを表示

• [0]: string

{
    "description":"The list of attributes of DN syntax that must NOT be transformed. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-white-list-attributes

型: array

変換する必要があるDN構文の属性のリスト。

ソースを表示

• [0]: string

{
    "description":"The list of attributes of DN syntax that must be transformed. ",
    "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."
        }
    }
}

先頭に戻る