ジャンプ先

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

DNによる結合ワークフロー要素の変更

PATCH

/rest/v1/admin/{dn}

DNによる結合ワークフロー要素の変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要がある結合パーティション

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): 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制御。

ソースを表示

• 配列: 文字列

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

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

型: array

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

ソースを表示

• 配列: オブジェクト PatchOperation

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

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

型: object

ソースを表示

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

  パッチ操作のタイプ。
• values: 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

更新する属性値。

ソースを表示

• 配列: 文字列

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: 結合ワークフロー要素のPatchSuccessResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): 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 Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト 結合ワークフロー要素のSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Union Workflow Element SearchResultEntry"
    }
}

ネストされたスキーマ: 結合ワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes(required): object 結合ワークフロー要素のプロパティ
• dn(required): 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 Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: 結合ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-auto-tune-search-option: boolean
  デフォルト値: false

  search-first-matchプロパティがtrueに設定されている場合、!(uid=user.1)などのフィルタを使用したサブツリー検索では、通常は1つのエントリがターゲットとなります。ただし、uid=user.2やuid=user.3なども、この条件の有効な結果であるため、複数のエントリがターゲットになる必要があります。search-first-matchがtrueに設定されている場合でも、結合ワークフロー要素で、条件に一致する複数のエントリが返されるようにするには、このプロパティをtrueに設定します。
• ds-cfg-base-dn: string
  読取り専用: true

  仮想統合DITのベースDN。
• ds-cfg-bind-option: string
  デフォルト値: bind-first-success

  指定可能な値: [ "bind-first-success", "bind-quick-fail" ]

  バインド・リクエストが最初に成功するまで、構成されているすべてのパーティションのリストを進んでいく必要があるか、構成されている別々のパーティションのDNが複数のユーザーで同一の場合には、失敗する必要があるかを示します。
• ds-cfg-cache-size: integer(int32)
  デフォルト値: 10000

  エントリ重複の除外に使用されるキャッシュに格納できる最大エントリ数。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.union.UnionWorkflowElement

  結合ワークフロー要素の実装を提供するJava classの完全修飾名を指定します。
• ds-cfg-search-first-match: boolean
  デフォルト値: true

  サブツリー検索でエントリが検出されたときに処理を停止するかどうかを示します。
• ds-cfg-suppress-entry-duplicates: boolean
  デフォルト値: false

  結合ワークフロー要素でエントリ重複の抑制を試行するかどうかを示します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "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 Union Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.union.UnionWorkflowElement",
            "type":"string"
        },
        "ds-cfg-auto-tune-search-option":{
            "description":"A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-cache-size":{
            "description":"The maximum number of entries that can be stored in the cache used to filter out entry duplicates. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-search-first-match":{
            "description":"Indicates if a subtree search should stop the processing once an entry is found. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-suppress-entry-duplicates":{
            "description":"Indicate whether the Union Workflow Element should try to suppress the entry duplicates. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bind-option":{
            "description":"Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions. ",
            "readOnly":false,
            "default":"bind-first-success",
            "type":"string",
            "enum":[
                "bind-first-success",
                "bind-quick-fail"
            ]
        },
        "ds-cfg-base-dn":{
            "description":"The base DN of the virtual unified DIT. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): 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."
        }
    }
}

先頭に戻る