ジャンプ先

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

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

PATCH

/rest/v1/admin/{dn}

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

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるRDN変更ワークフロー要素

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

本文 ()

ルート・スキーマ: RDN変更ワークフロー要素の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/RDN Changing Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト RDN変更ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: RDN変更ワークフロー要素のSearchResultEntry

型: object

ソースを表示

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

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

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-client-rdn(required): string
  初期RDNを置換するために使用される属性タイプを定義します。
• ds-cfg-dn-attributes: array ds-cfg-dn-attributes
  DNが含まれており、その値も変換される必要がある属性を定義します。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.ovdplugin.rdnchanging.RDNChangingWorkflowElement

  RDN変更ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-next-workflow-element(required): string
  ワークフロー要素のチェーン内の次のワークフロー要素を定義します。
• ds-cfg-objectclass(required): string
  デフォルト値: person

  変換が適用されるオブジェクト・クラスを識別します。
• ds-cfg-replace-value(required): boolean
  デフォルト値: true

  値も適応させる必要があるか、または属性名のみかを示します。trueの場合、RDN sourceRDN=sourceRDNAttributeValueは、clientRDN=clientRDNAttributeValueに置換され、falseの場合はclientRDN=sourceRDNAttributeValueに置換されます。
• ds-cfg-source-rdn(required): string
  指定された属性タイプのRDNコンポーネントがサーバー上のDNに含まれている場合、RDNは変換されます。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-source-rdn",
        "ds-cfg-next-workflow-element",
        "ds-cfg-objectclass",
        "ds-cfg-enabled",
        "ds-cfg-client-rdn",
        "ds-cfg-replace-value"
    ],
    "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 RDN Changing Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.rdnchanging.RDNChangingWorkflowElement",
            "type":"string"
        },
        "ds-cfg-source-rdn":{
            "description":"If the DN on the server contains a RDN component with the specified attribute type, then the RDN is transformed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-next-workflow-element":{
            "description":"Defines the next workflow element in the chain of workflow elements. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-objectclass":{
            "description":"Identifies the objectclass to which the transformation applies. ",
            "readOnly":false,
            "default":"person",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-client-rdn":{
            "description":"Defines the attribute type that will be used to replace the initial RDN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dn-attributes":{
            "description":"Defines the attributes that contain DN and whose value must also be transformed. ",
            "readOnly":false,
            "default":[
                "member",
                "manager",
                "owner"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-replace-value":{
            "description":"Indicates if the value must also be adapted or only the attribute name. If true, the RDN sourceRDN=sourceRDNAttributeValue is replaced by clientRDN=clientRDNAttributeValue, if false by clientRDN=sourceRDNAttributeValue. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

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

型: array

DNが含まれており、その値も変換される必要がある属性を定義します。

デフォルト値: [ "member", "manager", "owner" ]

ソースを表示

• 配列: 文字列

{
    "description":"Defines the attributes that contain DN and whose value must also be transformed. ",
    "readOnly":false,
    "default":[
        "member",
        "manager",
        "owner"
    ],
    "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."
        }
    }
}

先頭に戻る