Oracle Unified Directoryの管理REST API: フィルタによるエントリの非表示化ワークフロー要素のDNによる変更

フィルタによるエントリの非表示化ワークフロー要素の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レスポンス

ルート・スキーマ: フィルタによるエントリの非表示化ワークフロー要素の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/Hide Entries By Filter Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object フィルタによるエントリの非表示化ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: フィルタによるエントリの非表示化ワークフロー要素のプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-apply-for-admin: boolean

デフォルト値: false

フィルタリングをルート・ユーザーに適用できるかどうかを制御します。このパラメータをfalseに設定した場合、バインドされたユーザーがルート・ユーザーであれば、ワークフロー要素によりフィルタリングされずに、検索結果がそのまま返されます。
ds-cfg-enabled: boolean

サーバーでワークフロー要素が使用可能かどうかを示します。
ds-cfg-excluded-ldap-url(optional): array ds-cfg-excluded-ldap-url

除外フィルタリングに使用するLDAP URLのリストを指定します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement

フィルタによるエントリの非表示化ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-ldap-filter(optional): string

フィルタリングに使用するLDAPフィルタを指定します。
ds-cfg-ldap-url(optional): array ds-cfg-ldap-url

フィルタリングに使用するLDAP URLのリストを指定します。
ds-cfg-next-workflow-element: string

ワークフロー要素のチェーン内の次のワークフロー要素を定義します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-apply-for-admin",
        "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 Hide Entries By Filter Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement",
            "type":"string"
        },
        "ds-cfg-ldap-filter":{
            "description":"Specifies the LDAP filter used for the filtering. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-excluded-ldap-url":{
            "description":"Specifies a list of the LDAP URL used for the excluded filtering. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-apply-for-admin":{
            "description":"Control whether the filtering is applicable to root users. If this parameter is set to false, and the bound user is a root user, the search results are returned as is, without being further filtered by the workflow element. ",
            "readOnly":false,
            "default":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-ldap-url":{
            "description":"Specifies a list of the LDAP URL used for the filtering. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-excluded-ldap-url

型: array

除外フィルタリングに使用するLDAP URLのリストを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a list of the LDAP URL used for the excluded filtering. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ldap-url

型: array

フィルタリングに使用するLDAP URLのリストを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies a list of the LDAP URL used for the filtering. ",
    "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."
        }
    }
}

先頭に戻る