ジャンプ先

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

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

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

型: array

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

ソースを表示

• 配列: オブジェクト ゲートウェイ・ドメインのSearchResultEntry

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

ネストされたスキーマ: ゲートウェイ・ドメインのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-base-dn: string
  読取り専用: true

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

  レプリケーション・サーバーにローカルの変更時間を送信するときに、レプリケーション・ゲートウェイで使用されるハートビート間隔を指定します。
• ds-cfg-dscc-address: string
  読取り専用: true

  Oracle Directory Service Control Centerレジストリがデプロイされているホスト名とポート番号を指定します。
• ds-cfg-dscc-admin-dn: string
  読取り専用: true

  デフォルト値: cn=admin,cn=Administrators,cn=dscc

  Oracle Directory Service Control Centerを介した認証に使用されるDirectory Service Managerのユーザー名。
• ds-cfg-dsee-auth-protocol: string
  デフォルト値: clear

  指定可能な値: [ "clear", "ssl-client", "ssl-simple" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• ds-cfg-dsee-bind-dn: string
  デフォルト値: cn=replication manager,cn=replication,cn=config

  DSEEコンシューマへの接続に使用するバインドDNを指定する属性。
• ds-cfg-dsee-group-size: integer(int32)
  デフォルト値: 10

  DSEEレプリケーション・トランスポート・プロトコルを使用してDSEE LDAPサーバーと通信する際にレプリケーション・ゲートウェイが使用するグループ・サイズを指定します。
• ds-cfg-dsee-purge-delay: string
  デフォルト値: 604800s

  このレプリケーション・ゲートウェイの接続先のDSEEサーバーで定義されるパージ遅延を秒単位で指定します。
• ds-cfg-dsee-server: string
  レプリケーション・ゲートウェイ・サーバーが接続および更新を試みる、ゲートウェイ・ドメイン内のDSEEレプリケーション・サーバーのアドレスを指定します。
• ds-cfg-dsee-ssl-rsa-cert-name: string
  デフォルト値: server-cert

  クライアント認証の使用中にDSEEコンシューマに送信される証明書エイリアスを指定する属性
• ds-cfg-dsee-user-password: string
  DSEEレプリケーション・サーバーによってレプリケーション・ゲートウェイを認証するために使用されるパスワード。
• ds-cfg-dsee-window-size: integer(int32)
  デフォルト値: 100

  DSEEレプリケーション・トランスポート・プロトコルを使用してDSEE LDAPサーバーと通信する際にレプリケーション・ゲートウェイが使用するウィンドウ・サイズを指定します。
• ds-cfg-group-id: integer(int32)
  デフォルト値: 1

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

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

  ディレクトリ・サーバーがレプリケーション・サーバーと通信する際に使用するハートビート間隔を指定します。
• ds-cfg-key-manager-provider: string
  デフォルト値: JKS

  このゲートウェイ・ドメインとともに使用するキー・マネージャの名前を指定します。
• ds-cfg-repl-bind-dn: array ds-cfg-repl-bind-dn
  レプリケーション目的のバインドを許可されたレプリケーション・マネージャのDN。
• ds-cfg-replicate-oud-changes: boolean
  デフォルト値: true

  ゲートウェイ・ドメインがOracle Unified Directoryトポロジから変更をレプリケートしているかどうかを示します。FALSEに設定すると、DSEEの更新のみがゲートウェイ経由で伝播されます。
• ds-cfg-replication-server(required): array ds-cfg-replication-server
  ディレクトリ・サーバーが起動時に接続を試みる、ゲートウェイ・ドメイン内のレプリケーション・サーバーのアドレスを指定します。
• ds-cfg-server-id: integer(int32)
  読取り専用: true

  ゲートウェイ・ドメイン内のディレクトリ・サーバーに一意の識別子を指定します。
• ds-cfg-trust-manager-provider: string
  デフォルト値: JKS

  ゲートウェイ・ドメインとともに使用する信頼マネージャの名前を指定します。
• ds-cfg-window-size: integer(int32)
  デフォルト値: 100

  ディレクトリ・サーバーがレプリケーション・サーバーと通信する際に使用するウィンドウ・サイズを指定します。
• 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-group-id":{
            "description":"The group id associated with this replicated domain. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-server":{
            "description":"Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dsee-bind-dn":{
            "description":"Attribute specifying which bind dn is to be used to connect the DSEE consumer. ",
            "readOnly":false,
            "default":"cn=replication manager,cn=replication,cn=config",
            "type":"string"
        },
        "ds-cfg-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-dsee-user-password":{
            "description":"The password used to authenticate the Replication Gateway by the DSEE Replication Servers. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-repl-bind-dn":{
            "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
            "readOnly":false,
            "default":[
                "cn=replication manager,cn=replication,cn=config"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the replicated data. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-dsee-group-size":{
            "description":"Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":"10",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dscc-admin-dn":{
            "description":"The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center. ",
            "readOnly":true,
            "default":"cn=admin,cn=Administrators,cn=dscc",
            "type":"string"
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-replicate-oud-changes":{
            "description":"Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dsee-window-size":{
            "description":"Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-purge-delay":{
            "description":"Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to. ",
            "readOnly":false,
            "default":"604800s",
            "type":"string"
        },
        "ds-cfg-dsee-auth-protocol":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"clear",
            "type":"string",
            "enum":[
                "clear",
                "ssl-client",
                "ssl-simple"
            ]
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dscc-address":{
            "description":"Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed. ",
            "readOnly":true,
            "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-dsee-ssl-rsa-cert-name":{
            "description":"Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication ",
            "readOnly":false,
            "default":"server-cert",
            "type":"string"
        },
        "ds-cfg-server-id":{
            "description":"Specifies a unique identifier for the Directory Server within the Gateway Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

レプリケーション目的のバインドを許可されたレプリケーション・マネージャのDN。

デフォルト値: [ "cn=replication manager,cn=replication,cn=config" ]

ソースを表示

• 配列: 文字列

{
    "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
    "readOnly":false,
    "default":[
        "cn=replication manager,cn=replication,cn=config"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the addresses of the Replication Servers within the Gateway 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."
        }
    }
}

先頭に戻る