ジャンプ先

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

DNによるリクエスト・フィルタリングQOSポリシーの変更

PATCH

/rest/v1/admin/{dn}

DNによるリクエスト・フィルタリングQOSポリシーの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるリクエスト・フィルタリングQOSポリシー

ルート・スキーマ: 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

本文 ()

ルート・スキーマ: リクエスト・フィルタリングQOSポリシーの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/Request Filtering QOS Policy SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト リクエスト・フィルタリングQOSポリシーのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Request Filtering QOS Policy SearchResultEntry"
    }
}

ネストされたスキーマ: リクエスト・フィルタリングQOSポリシーのSearchResultEntry

型: object

ソースを表示

• attributes(required): object リクエスト・フィルタリングQOSポリシーのプロパティ
• 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/Request Filtering QOS Policy Properties"
        }
    }
}

ネストされたスキーマ: リクエスト・フィルタリングQOSポリシーのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-allowed-attributes: array ds-cfg-allowed-attributes
  検索操作および比較操作で許可される属性を指定します。
• ds-cfg-allowed-operations: array ds-cfg-allowed-operations
  サーバーによって許可される操作を指定します。
• ds-cfg-allowed-search-scopes: array ds-cfg-allowed-search-scopes
  サーバーによって許可される検索範囲を指定します。
• ds-cfg-allowed-subtrees: array ds-cfg-allowed-subtrees
  クライアントがアクセス可能なサブツリーを指定します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.core.networkgroups.RequestFilteringPolicyFactory

  リクエスト・フィルタリングQOSポリシーの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-prohibited-attributes: array ds-cfg-prohibited-attributes
  検索操作および比較操作で許可されない属性を指定します。
• ds-cfg-prohibited-subtrees: array ds-cfg-prohibited-subtrees
  クライアントに非公開にする必要があるサブツリーを指定します。禁止される各サブツリーは、許可されたサブツリーの下位にある必要があります。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class"
    ],
    "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 Request Filtering QOS Policy implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.networkgroups.RequestFilteringPolicyFactory",
            "type":"string"
        },
        "ds-cfg-allowed-attributes":{
            "description":"Specifies which attributes are allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-search-scopes":{
            "description":"Specifies which search scopes are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "base",
                "children",
                "one",
                "sub"
            ]
        },
        "ds-cfg-prohibited-subtrees":{
            "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-subtrees":{
            "description":"Specifies which subtrees are accessible to clients. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-operations":{
            "description":"Specifies which operations are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "inequality-search",
                "modify",
                "rename",
                "search"
            ]
        },
        "ds-cfg-prohibited-attributes":{
            "description":"Specifies which attributes are not allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

検索操作および比較操作で許可される属性を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which attributes are allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

サーバーによって許可される操作を指定します。

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

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which operations are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "inequality-search",
        "modify",
        "rename",
        "search"
    ]
}

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

型: array

サーバーによって許可される検索範囲を指定します。

指定可能な値: [ "base", "children", "one", "sub" ]

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which search scopes are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "base",
        "children",
        "one",
        "sub"
    ]
}

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

型: array

クライアントがアクセス可能なサブツリーを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which subtrees are accessible to clients. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

検索操作および比較操作で許可されない属性を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which attributes are not allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-prohibited-subtrees

型: array

クライアントに非公開にする必要があるサブツリーを指定します。禁止される各サブツリーは、許可されたサブツリーの下位にある必要があります。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "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."
        }
    }
}

先頭に戻る