ジャンプ先

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

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/Replication Domain SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト レプリケーション・ドメインのSearchResultEntry

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

ネストされたスキーマ: レプリケーション・ドメインのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-assured-sd-level: integer(int32)
  デフォルト値: 1

  セーフ・データ保証サブ・モードに対する肯定応答のレベル。
• ds-cfg-assured-timeout: string
  デフォルト値: 2000ms

  保証レプリケーションの肯定応答を待機する際のタイムアウト値。
• ds-cfg-assured-type: string
  デフォルト値: not-assured

  指定可能な値: [ "not-assured", "safe-data", "safe-read" ]

  レプリケートされるドメインの保証レプリケーション・モードを定義します。
• ds-cfg-base-dn: string
  読取り専用: true

  レプリケートされたデータのベースDNを指定します。
• ds-cfg-changetime-heartbeat-interval: string
  デフォルト値: 1000ms

  ディレクトリ・サーバーがレプリケーション・サーバーにローカル変更時間を送信するときに使用するハートビート間隔を指定します。
• ds-cfg-conflicts-historical-purge-delay: string
  デフォルト値: 1440m

  この遅延は、競合を解決するために必要な履歴情報がドメインで保持される時間(分)を示します。ユーザー・エントリの履歴部分に格納されている変更に、この遅延よりも古い(レプリケーションのChangeNumberからの)日付がある場合、パージの候補となります。パージは、エントリの変更と専用パージ・タスクという2つのイベントで適用されます。
• ds-cfg-fractional-exclude: array ds-cfg-fractional-exclude
  このサーバーへのレプリケート対象から特定の属性を除外できます。
• ds-cfg-fractional-include: array ds-cfg-fractional-include
  このサーバーへのレプリケート対象に特定の属性を含めることができます。
• ds-cfg-group-id: integer(int32)
  デフォルト値: 1

  このレプリケートされたドメインに関連付けられているグループID。
• ds-cfg-handshake-timeout: string
  デフォルト値: 4000ms

  レプリケーション・サーバー間のハンドシェークにおけるハンドシェークのタイムアウト間隔を指定します。
• ds-cfg-heartbeat-interval: string
  デフォルト値: 10000ms

  ディレクトリ・サーバーがレプリケーション・サーバーと通信する際に使用するハートビート間隔を指定します。
• ds-cfg-initialization-window-size: integer(int32)
  デフォルト値: 100

  このディレクトリ・サーバーが初期化のためにリモート・ディレクトリ・サーバーと通信するときに使用できるウィンドウ・サイズを指定します。
• ds-cfg-isolation-policy: string
  デフォルト値: reject-all-updates

  指定可能な値: [ "accept-all-updates", "reject-all-updates" ]

  使用可能な構成済レプリケーション・サーバーがないときにレプリケーション・ドメイン内のデータに対して書込み操作が試行された場合のディレクトリ・サーバーの動作を指定します。
• ds-cfg-log-changenumber: boolean
  デフォルト値: false

  このサーバーでChangeNumberをアクセス・ログに記録するかどうかを示します。
• ds-cfg-pending-changes-max-size: integer(int32)
  デフォルト値: 10000

  この値は、保留中の変更のリストの最大サイズを示します。
• ds-cfg-publish-referrals: boolean
  デフォルト値: true

  ローカル・サーバーが固有のリフェラルをトポロジの他の部分に公開するかどうかを示します。
• ds-cfg-referrals-url: array ds-cfg-referrals-url
  他のLDAPサーバーがローカル・サーバーを参照するために使用するURL。
• ds-cfg-replication-server(required): array ds-cfg-replication-server
  ディレクトリ・サーバーが起動時に接続しようとするレプリケーション・ドメイン内のレプリケーション・サーバーのアドレスを指定します。
• ds-cfg-server-id: integer(int32)
  読取り専用: true

  レプリケーション・ドメイン内のディレクトリ・サーバーの一意の識別子を指定します。
• ds-cfg-solve-conflicts: boolean
  デフォルト値: true

  このサーバーが競合を解決するかどうかを示します。
• ds-cfg-window-size: integer(int32)
  デフォルト値: 100

  ディレクトリ・サーバーがレプリケーション・サーバーと通信する際に使用するウィンドウ・サイズを指定します。
• ds-cfg-workflow-element: string
  レプリケーション・ドメイン内の関連ワークフロー要素を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-server"
    ],
    "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-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-pending-changes-max-size":{
            "description":"This value indicates the maximum size of the pending changes list. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs other LDAP servers should use to refer to the local server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-group-id":{
            "description":"The group ID associated with this replicated domain. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-isolation-policy":{
            "description":"Specifies the behavior of the Directory Server if a write operation is attempted on the data within the Replication Domain when none of the configured Replication Servers are available. ",
            "readOnly":false,
            "default":"reject-all-updates",
            "type":"string",
            "enum":[
                "accept-all-updates",
                "reject-all-updates"
            ]
        },
        "ds-cfg-assured-type":{
            "description":"Defines the assured replication mode of the replicated domain. ",
            "readOnly":false,
            "default":"not-assured",
            "type":"string",
            "enum":[
                "not-assured",
                "safe-data",
                "safe-read"
            ]
        },
        "ds-cfg-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Directory Server will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-solve-conflicts":{
            "description":"Indicates if this server solves conflicts. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the replicated data. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-log-changenumber":{
            "description":"Indicates if this server logs the ChangeNumber in access log. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-fractional-exclude":{
            "description":"Allows you to exclude specific attributes from being replicated to this server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-publish-referrals":{
            "description":"Indicates whether the local server is publishing its own referrals to the rest of the topology. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-assured-sd-level":{
            "description":"The level of acknowledgment for Safe Data assured sub mode. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-initialization-window-size":{
            "description":"Specifies the window size that this Directory Server may use when communicating with remote Directory Servers for initialization. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-assured-timeout":{
            "description":"The timeout value when waiting for assured replication acknowledgments. ",
            "readOnly":false,
            "default":"2000ms",
            "type":"string"
        },
        "ds-cfg-conflicts-historical-purge-delay":{
            "description":"This delay indicates the time (in minutes) the domain keeps the historical information necessary to solve conflicts.When a change stored in the historical part of the user entry has a date (from its replication ChangeNumber) older than this delay, it is candidate to be purged. The purge is applied on 2 events: modify of the entry, dedicated purge task. ",
            "readOnly":false,
            "default":"1440m",
            "type":"string"
        },
        "ds-cfg-fractional-include":{
            "description":"Allows you to include specific attributes to be replicated to this server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-workflow-element":{
            "description":"Specifies the related Workflow Element in the Replication Domain . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Replication Domain to which the Directory Server should try to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-server-id":{
            "description":"Specifies a unique identifier for the Directory Server within the Replication Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

このサーバーへのレプリケート対象から特定の属性を除外できます。

ソースを表示

• 配列: 文字列

{
    "description":"Allows you to exclude specific attributes from being replicated to this server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このサーバーへのレプリケート対象に特定の属性を含めることができます。

ソースを表示

• 配列: 文字列

{
    "description":"Allows you to include specific attributes to be replicated to this server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

他のLDAPサーバーがローカル・サーバーを参照するために使用するURL。

ソースを表示

• 配列: 文字列

{
    "description":"The URLs other LDAP servers should use to refer to the local server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ディレクトリ・サーバーが起動時に接続しようとするレプリケーション・ドメイン内のレプリケーション・サーバーのアドレスを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the addresses of the Replication Servers within the Replication Domain to which the Directory Server should try to connect at startup time. ",
    "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."
        }
    }
}

先頭に戻る