ジャンプ先

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

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/Dynamic Groups Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト 動的グループ・ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: 動的グループ・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-allowed-filter-count: integer(int32)
  デフォルト値: 100

  これは主に、dynamicgroupsworkflowelementのパフォーマンスを最適化するために使用されます。
• ds-cfg-check-url-base: boolean
  デフォルト値: false

  メンバーシップ・テスト問合せを実行する際に、memberURLに指定されているベースおよび有効範囲を尊重するかどうかを示すブール値。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-expand-url: boolean
  動的グループが展開される必要があるかどうかを示すブール。
• ds-cfg-fetch-both-static-dynamic: boolean
  デフォルト値: false

  ユーザーがメンバーである静的グループと動的グループの両方を取得するかどうかを示すブール値。
• ds-cfg-global-search: boolean
  デフォルト値: false

  動的グループを展開する際、グローバル検索を実行するかどうかを示すブール値。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.ovdplugin.dynamicgroups.DynamicGroupsWorkflowElement

  動的グループ・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-member-attribute: string
  デフォルト値: uniquemember

  グループ・メンバー値を格納する属性の名前。
• ds-cfg-nativememberof-attribute: string
  バックエンドによってサポートされている場合にネイティブ・メンバー属性の名前を指定できるオプションの値。
• ds-cfg-next-workflow-element(required): string
  ワークフロー要素のチェーン内の次のワークフロー要素を定義します。
• ds-cfg-use-nativememberof-support: boolean
  デフォルト値: false

  バックエンド・ディレクトリでサポートされている場合に、バックエンド・ディレクトリからのサポートのネイティブ・メンバーを使用するかどうかを示すブール。dynamicgroupsworkflowelement関連の問合せのパフォーマンスを向上させます。
• ds-cfg-user-search-base: string
  LDAP URLに指定されているベースを上書きする必要がある仮想検索ベース用のオプションの値。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-next-workflow-element",
        "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 Dynamic Groups Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.dynamicgroups.DynamicGroupsWorkflowElement",
            "type":"string"
        },
        "ds-cfg-check-url-base":{
            "description":"Boolean indicating whether or not to honor the base and scope specified in memberURL while performing membership test queries. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-fetch-both-static-dynamic":{
            "description":"Boolean indicating whether or not to fetch both static and dynamic groups which a user is a memer of. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-use-nativememberof-support":{
            "description":"Boolean indicating whether or not to use the native memberof support from the backend directory,if supported by the backend directory.To improve the performance of dynamicgroupsworkflowelement related queries. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-user-search-base":{
            "description":"Optional value for a virtual search base that needs to override the base specified in an LDAP URL. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-expand-url":{
            "description":"Boolean indicating whether the dynamic groups have to be expanded or not. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-next-workflow-element":{
            "description":"Defines the next workflow element in the chain of workflow elements. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-member-attribute":{
            "description":"Name of the attribute that stores group member values. ",
            "readOnly":false,
            "default":"uniquemember",
            "type":"string"
        },
        "ds-cfg-global-search":{
            "description":"Boolean indicating whether or not to perform global search while expanding dynamic group. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-filter-count":{
            "description":"This is mainly used to optimize the performance of dynamicgroupsworkflowelement. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-nativememberof-attribute":{
            "description":"Optional value for which you can specify name of the native memberof attribute if supported by the backend. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

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

先頭に戻る