Oracle Unified Directory管理REST API

グローバル索引カタログのレプリケーション・ドメインの追加、検索、比較または削除

POST

/rest/v1/admin

グローバル索引カタログのレプリケーション・ドメインの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要があるグローバル索引カタログのレプリケーション・ドメイン

ルート・スキーマ: グローバル索引カタログのレプリケーション・ドメインのPOSTRequest

型: object

ソースを表示

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Global Index Catalog Replication Domain Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

ネストされたスキーマ: グローバル索引カタログのレプリケーション・ドメインのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-changetime-heartbeat-interval: string

デフォルト値: 1000ms

レプリケーション・サーバーにローカルの変更時間を送信するときに、インスタンスで使用されるハートビート間隔を指定します。
ds-cfg-group-id: integer(int32)

デフォルト値: 1

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

デフォルト値: 4000ms

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

デフォルト値: 1000ms

インスタンスがレプリケーション・サーバーと通信する際に使用するハートビート間隔を指定します。
ds-cfg-replication-server(required): array ds-cfg-replication-server

グローバル索引が起動時に接続を試みる、グローバル索引カタログのレプリケーション・ドメイン内のレプリケーション・サーバーのアドレスを指定します。
ds-cfg-server-id: integer(int32)

読取り専用: true

グローバル索引カタログのレプリケーション・ドメイン内のグローバル索引に一意の識別子を指定します。
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 instance will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"1000ms",
            "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-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the instance will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index 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 instance 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 global index within the Global Index Catalog Replication Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

LDAP操作のためにサーバーに送信するLDAP制御。

ソースを表示

配列: 文字列

{
    "description":"LDAP controls to be sent to server for the LDAP operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

ソースを表示

配列: 文字列

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

グローバル索引が起動時に接続を試みる、グローバル索引カタログのレプリケーション・ドメイン内のレプリケーション・サーバーのアドレスを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index 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"
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: グローバル索引カタログのレプリケーション・ドメインのSuccessResponse

型: object

ソースを表示

compareResult: boolean

LDAP比較操作の結果を示します。
msgType(required): string

指定可能な値: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

RESTメッセージ・タイプ
searchResultEntries(required): array searchResultEntries

LDAP操作後に返される検索結果エントリの数。
totalResults(required): integer(int32)

作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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/Global Index Catalog Replication Domain SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

配列: オブジェクトグローバル索引カタログのレプリケーション・ドメインのSearchResultEntry

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

ネストされたスキーマ: グローバル索引カタログのレプリケーション・ドメインのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-changetime-heartbeat-interval: string

デフォルト値: 1000ms

レプリケーション・サーバーにローカルの変更時間を送信するときに、インスタンスで使用されるハートビート間隔を指定します。
ds-cfg-group-id: integer(int32)

デフォルト値: 1

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

デフォルト値: 4000ms

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

デフォルト値: 1000ms

インスタンスがレプリケーション・サーバーと通信する際に使用するハートビート間隔を指定します。
ds-cfg-replication-server(required): array ds-cfg-replication-server

グローバル索引が起動時に接続を試みる、グローバル索引カタログのレプリケーション・ドメイン内のレプリケーション・サーバーのアドレスを指定します。
ds-cfg-server-id: integer(int32)

読取り専用: true

グローバル索引カタログのレプリケーション・ドメイン内のグローバル索引に一意の識別子を指定します。
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 instance will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"1000ms",
            "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-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the instance will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index 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 instance 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 global index within the Global Index Catalog Replication Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

ソースを表示

配列: 文字列

{
    "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index 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"
    }
}

201レスポンス

作成済

ルート・スキーマ: グローバル索引カタログのレプリケーション・ドメインのADDResponse

型: object

ソースを表示

msgType(required): string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

RESTメッセージ・タイプ
searchResultEntries(required): array searchResultEntries
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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Global Index Catalog Replication Domain SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

配列: オブジェクトグローバル索引カタログのレプリケーション・ドメインのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Global Index Catalog 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/Global Index Catalog Replication Domain Properties"
        }
    }
}

ネストされたスキーマ: グローバル索引カタログのレプリケーション・ドメインのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-changetime-heartbeat-interval: string

デフォルト値: 1000ms

レプリケーション・サーバーにローカルの変更時間を送信するときに、インスタンスで使用されるハートビート間隔を指定します。
ds-cfg-group-id: integer(int32)

デフォルト値: 1

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

デフォルト値: 4000ms

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

デフォルト値: 1000ms

インスタンスがレプリケーション・サーバーと通信する際に使用するハートビート間隔を指定します。
ds-cfg-replication-server(required): array ds-cfg-replication-server

グローバル索引が起動時に接続を試みる、グローバル索引カタログのレプリケーション・ドメイン内のレプリケーション・サーバーのアドレスを指定します。
ds-cfg-server-id: integer(int32)

読取り専用: true

グローバル索引カタログのレプリケーション・ドメイン内のグローバル索引に一意の識別子を指定します。
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 instance will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"1000ms",
            "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-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the instance will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index 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 instance 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 global index within the Global Index Catalog Replication Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

ソースを表示

配列: 文字列

{
    "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index 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"
    }
}

204レスポンス

コンテンツがありません

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."
        }
    }
}

先頭に戻る