ジャンプ先

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

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/Is Member Of Virtual Attribute SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object 仮想属性のメンバーのSearchResultEntry

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

ネストされたスキーマ: 仮想属性のメンバーのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-attribute-type: string
  デフォルト値: isMemberOf

  仮想属性によって値が動的に割り当てられる属性の属性タイプを指定します。
• ds-cfg-base-dn(optional): array ds-cfg-base-dn
  この仮想属性の使用に適したエントリが含まれている分岐のベースDNを指定します。
• ds-cfg-conflict-behavior(optional): string
  デフォルト値: virtual-overrides-real

  指定可能な値: [ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]

  エントリに関連した属性の実値が1つまたは複数格納されている場合のサーバーの動作を指定します。
• ds-cfg-enabled: boolean
  仮想属性が使用可能かどうかを示します。
• ds-cfg-filter(optional): array ds-cfg-filter
  これらのエントリに対して仮想属性を生成するかどうかを決定するために、エントリに適用される検索フィルタを指定します。
• ds-cfg-group-dn(optional): array ds-cfg-group-dn
  この仮想属性の使用に適したメンバーを持つグループのDNを入力します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.extensions.IsMemberOfVirtualAttributeProvider

  属性値を生成する仮想属性プロバイダ・クラスの完全修飾名を指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-attribute-type",
        "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-filter":{
            "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
            "readOnly":false,
            "default":[
                "(objectClass=*)"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.IsMemberOfVirtualAttributeProvider",
            "type":"string"
        },
        "ds-cfg-conflict-behavior":{
            "description":"Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. ",
            "readOnly":false,
            "default":"virtual-overrides-real",
            "type":"string",
            "enum":[
                "merge-real-and-virtual",
                "real-overrides-virtual",
                "virtual-overrides-real"
            ]
        },
        "ds-cfg-group-dn":{
            "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute-type":{
            "description":"Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute. ",
            "readOnly":false,
            "default":"isMemberOf",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Virtual Attribute is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-base-dn

型: array

この仮想属性の使用に適したエントリが含まれている分岐のベースDNを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

これらのエントリに対して仮想属性を生成するかどうかを決定するために、エントリに適用される検索フィルタを指定します。

デフォルト値: [ "(objectClass=*)" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
    "readOnly":false,
    "default":[
        "(objectClass=*)"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-group-dn

型: array

この仮想属性の使用に適したメンバーを持つグループのDNを入力します。

ソースを表示

• [0]: string

{
    "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
    "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."
        }
    }
}

先頭に戻る