Oracle Unified Directory管理REST API

ローカルDB VLV索引の追加、検索、比較または削除

POST

/rest/v1/admin

ローカルDB VLV索引の追加、検索、比較または削除

リクエスト

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

application/json

作成する必要があるローカルDB VLV索引

ルート・スキーマ: ローカルDB VLV索引のPOSTRequest

型: object

ソースを表示

assertion: string

LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes: object ローカルDB VLV索引のプロパティ
base: string

LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
controls: array controls

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

作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
filter: string

LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
msgType(required): string

指定可能な値: [ "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" ]

RESTメッセージ・タイプ
requiredAttributes: array requiredAttributes

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

指定可能な値: [ "base", "sub", "one" ]

LDAP検索操作の範囲。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

{
    "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/Local DB VLV Index 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"
        }
    }
}

ネストされたスキーマ: ローカルDB VLV索引のプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-base-dn(required): string

索引付けされる検索問合せで使用されるベースDNを指定します。
ds-cfg-filter(required): string

索引を作成する問合せで使用されるLDAPフィルタを指定します。
ds-cfg-max-block-size: integer(int32)

読取り専用: true

デフォルト値: 4000

分割される前に単一のソートされたセットに格納されるエントリIDの数を指定します。
ds-cfg-name: string

読取り専用: true

VLV索引に一意の名前を指定します。
ds-cfg-scope(required): string

指定可能な値: [ "base-object", "single-level", "subordinate-subtree", "whole-subtree" ]

索引付けされる問合せのLDAPスコープを指定します。
ds-cfg-sort-order(required): string

索引を作成する問合せのエントリのソートに使用される属性の名前を指定します。
objectclass(required): array objectclass

このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-filter",
        "ds-cfg-sort-order",
        "ds-cfg-scope",
        "ds-cfg-base-dn"
    ],
    "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 LDAP filter used in the query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-max-block-size":{
            "description":"Specifies the number of entry IDs to store in a single sorted set before it must be split. ",
            "readOnly":true,
            "default":"4000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-sort-order":{
            "description":"Specifies the names of the attributes that are used to sort the entries for the query being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-scope":{
            "description":"Specifies the LDAP scope of the query that is being indexed. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "base-object",
                "single-level",
                "subordinate-subtree",
                "whole-subtree"
            ]
        },
        "ds-cfg-name":{
            "description":"Specifies a unique name for this VLV index. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN used in the search query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

ネストされたスキーマ: 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"
    }
}

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

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: ローカルDB VLV索引の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/Local DB VLV Index SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

配列: オブジェクトローカルDB VLV索引のSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Local DB VLV Index SearchResultEntry"
    }
}

ネストされたスキーマ: ローカルDB VLV索引のSearchResultEntry

型: object

ソースを表示

attributes(required): object ローカルDB VLV索引のプロパティ
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/Local DB VLV Index Properties"
        }
    }
}

ネストされたスキーマ: ローカルDB VLV索引のプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-base-dn(required): string

索引付けされる検索問合せで使用されるベースDNを指定します。
ds-cfg-filter(required): string

索引を作成する問合せで使用されるLDAPフィルタを指定します。
ds-cfg-max-block-size: integer(int32)

読取り専用: true

デフォルト値: 4000

分割される前に単一のソートされたセットに格納されるエントリIDの数を指定します。
ds-cfg-name: string

読取り専用: true

VLV索引に一意の名前を指定します。
ds-cfg-scope(required): string

指定可能な値: [ "base-object", "single-level", "subordinate-subtree", "whole-subtree" ]

索引付けされる問合せのLDAPスコープを指定します。
ds-cfg-sort-order(required): string

索引を作成する問合せのエントリのソートに使用される属性の名前を指定します。
objectclass(required): array objectclass

このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-filter",
        "ds-cfg-sort-order",
        "ds-cfg-scope",
        "ds-cfg-base-dn"
    ],
    "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 LDAP filter used in the query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-max-block-size":{
            "description":"Specifies the number of entry IDs to store in a single sorted set before it must be split. ",
            "readOnly":true,
            "default":"4000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-sort-order":{
            "description":"Specifies the names of the attributes that are used to sort the entries for the query being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-scope":{
            "description":"Specifies the LDAP scope of the query that is being indexed. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "base-object",
                "single-level",
                "subordinate-subtree",
                "whole-subtree"
            ]
        },
        "ds-cfg-name":{
            "description":"Specifies a unique name for this VLV index. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN used in the search query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

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

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

201レスポンス

作成済

ルート・スキーマ: ローカルDB VLV索引の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/Local DB VLV Index SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

配列: オブジェクトローカルDB VLV索引のSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Local DB VLV Index SearchResultEntry"
    }
}

ネストされたスキーマ: ローカルDB VLV索引のSearchResultEntry

型: object

ソースを表示

attributes(required): object ローカルDB VLV索引のプロパティ
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/Local DB VLV Index Properties"
        }
    }
}

ネストされたスキーマ: ローカルDB VLV索引のプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-base-dn(required): string

索引付けされる検索問合せで使用されるベースDNを指定します。
ds-cfg-filter(required): string

索引を作成する問合せで使用されるLDAPフィルタを指定します。
ds-cfg-max-block-size: integer(int32)

読取り専用: true

デフォルト値: 4000

分割される前に単一のソートされたセットに格納されるエントリIDの数を指定します。
ds-cfg-name: string

読取り専用: true

VLV索引に一意の名前を指定します。
ds-cfg-scope(required): string

指定可能な値: [ "base-object", "single-level", "subordinate-subtree", "whole-subtree" ]

索引付けされる問合せのLDAPスコープを指定します。
ds-cfg-sort-order(required): string

索引を作成する問合せのエントリのソートに使用される属性の名前を指定します。
objectclass(required): array objectclass

このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-filter",
        "ds-cfg-sort-order",
        "ds-cfg-scope",
        "ds-cfg-base-dn"
    ],
    "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 LDAP filter used in the query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-max-block-size":{
            "description":"Specifies the number of entry IDs to store in a single sorted set before it must be split. ",
            "readOnly":true,
            "default":"4000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-sort-order":{
            "description":"Specifies the names of the attributes that are used to sort the entries for the query being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-scope":{
            "description":"Specifies the LDAP scope of the query that is being indexed. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "base-object",
                "single-level",
                "subordinate-subtree",
                "whole-subtree"
            ]
        },
        "ds-cfg-name":{
            "description":"Specifies a unique name for this VLV index. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN used in the search query that is being indexed. ",
            "readOnly":false,
            "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."
        }
    }
}

先頭に戻る