ジャンプ先

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

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

POST

/rest/v1/admin

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

リクエスト

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

• application/json

本文 ()

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

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

型: object

ソースを表示

• assertion(optional): string
  LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
• attributes(optional): object ローカルDB索引のプロパティ
• base(optional): string
  LDAP検索操作に使用する検索ベースDN。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
• controls(optional): array controls
  LDAP操作のためにサーバーに送信するLDAP制御。
• dn(optional): 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(optional): string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• msgType: 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(optional): array requiredAttributes
  エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• scope(optional): 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 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索引のプロパティ

型: object

ソースを表示

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

  索引が維持される属性の名前を指定します。
• ds-cfg-index-entry-limit(optional): integer(int32)
  指定された索引キーが維持されなくなる前に、この索引キーを照合できるエントリの最大数を指定します。
• ds-cfg-index-extensible-matching-rule(optional): array ds-cfg-index-extensible-matching-rule
  拡張可能な索引の拡張可能な一致ルール。
• ds-cfg-index-type: array ds-cfg-index-type
  関連付けられた属性に対して実行する索引作成のタイプを指定します。
• ds-cfg-purging(optional): boolean
  デフォルト値: false

  索引順の値をパージするかどうかを示します。
• ds-cfg-substring-length(optional): integer(int32)
  デフォルト値: 6

  部分文字列索引の部分文字列の長さ。
• ds-cfg-tombstones-included(optional): boolean
  デフォルト値: false

  その索引がツームストン・エントリに対しても保持されるかどうかを示します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":6,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• [0]: string

{
    "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である場合)にのみ使用します。

ソースを表示

• [0]: string

{
    "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-index-extensible-matching-rule

型: array

拡張可能な索引の拡張可能な一致ルール。

ソースを表示

• [0]: string

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-index-type

型: array

関連付けられた属性に対して実行する索引作成のタイプを指定します。

指定可能な値: [ "approximate", "equality", "extensible", "ordering", "presence", "substring" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

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

型: array

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

ソースを表示

• [0]: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

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

型: object

ソースを表示

• compareResult(optional): boolean
  LDAP比較操作の結果を示します。
• msgType: 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: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults: 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 Index SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object ローカルDB索引のSearchResultEntry

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

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

型: object

ソースを表示

• attributes: object ローカルDB索引のプロパティ
• dn: 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 Index Properties"
        }
    }
}

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

型: object

ソースを表示

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

  索引が維持される属性の名前を指定します。
• ds-cfg-index-entry-limit(optional): integer(int32)
  指定された索引キーが維持されなくなる前に、この索引キーを照合できるエントリの最大数を指定します。
• ds-cfg-index-extensible-matching-rule(optional): array ds-cfg-index-extensible-matching-rule
  拡張可能な索引の拡張可能な一致ルール。
• ds-cfg-index-type: array ds-cfg-index-type
  関連付けられた属性に対して実行する索引作成のタイプを指定します。
• ds-cfg-purging(optional): boolean
  デフォルト値: false

  索引順の値をパージするかどうかを示します。
• ds-cfg-substring-length(optional): integer(int32)
  デフォルト値: 6

  部分文字列索引の部分文字列の長さ。
• ds-cfg-tombstones-included(optional): boolean
  デフォルト値: false

  その索引がツームストン・エントリに対しても保持されるかどうかを示します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":6,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-index-extensible-matching-rule

型: array

拡張可能な索引の拡張可能な一致ルール。

ソースを表示

• [0]: string

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-index-type

型: array

関連付けられた属性に対して実行する索引作成のタイプを指定します。

指定可能な値: [ "approximate", "equality", "extensible", "ordering", "presence", "substring" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

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

型: array

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

ソースを表示

• [0]: string

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

201レスポンス

作成済

本文 ()

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

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
• totalResults: 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 Index SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object ローカルDB索引のSearchResultEntry

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

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

型: object

ソースを表示

• attributes: object ローカルDB索引のプロパティ
• dn: 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 Index Properties"
        }
    }
}

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

型: object

ソースを表示

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

  索引が維持される属性の名前を指定します。
• ds-cfg-index-entry-limit(optional): integer(int32)
  指定された索引キーが維持されなくなる前に、この索引キーを照合できるエントリの最大数を指定します。
• ds-cfg-index-extensible-matching-rule(optional): array ds-cfg-index-extensible-matching-rule
  拡張可能な索引の拡張可能な一致ルール。
• ds-cfg-index-type: array ds-cfg-index-type
  関連付けられた属性に対して実行する索引作成のタイプを指定します。
• ds-cfg-purging(optional): boolean
  デフォルト値: false

  索引順の値をパージするかどうかを示します。
• ds-cfg-substring-length(optional): integer(int32)
  デフォルト値: 6

  部分文字列索引の部分文字列の長さ。
• ds-cfg-tombstones-included(optional): boolean
  デフォルト値: false

  その索引がツームストン・エントリに対しても保持されるかどうかを示します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":6,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-index-extensible-matching-rule

型: array

拡張可能な索引の拡張可能な一致ルール。

ソースを表示

• [0]: string

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-index-type

型: array

関連付けられた属性に対して実行する索引作成のタイプを指定します。

指定可能な値: [ "approximate", "equality", "extensible", "ordering", "presence", "substring" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

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

型: array

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

ソースを表示

• [0]: string

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

204レスポンス

コンテンツがありません

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode(optional): integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message: string
  操作に対して返されるエラー・メッセージ。
• msgType: 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."
        }
    }
}

先頭に戻る