Oracle Unified Directoryの管理REST API: DNによるオブジェクト・クラス変換のマップの検索

DNによるオブジェクト・クラス変換のマップの検索

GET

/rest/v1/admin/{dn}

DNによってオブジェクト・クラス変換のマップを返します

リクエスト

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

application/json

パス・パラメータ

dn: string

フェッチするエントリのLDAP DN。

問合せパラメータ

attributes: array

コレクション形式: multi

エントリに対してフェッチする属性のリスト。

[0]: string

{
    "name":"attributes",
    "in":"query",
    "description":"List of attributes to be fetched for the entry.",
    "type":"array",
    "collectionFormat":"multi",
    "items":{
        "type":"string"
    }
}

controls: array

コレクション形式: multi

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

[0]: string

{
    "name":"controls",
    "in":"query",
    "description":"LDAP controls to be sent to server for search operation.",
    "type":"array",
    "collectionFormat":"multi",
    "items":{
        "type":"string"
    }
}

filter: string

LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
scope: string

LDAP検索操作の範囲。

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: オブジェクト・クラス変換のマップのGetSuccessResponse

型: object

ソースを表示

msgType: string

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

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

LDAP操作後に返される検索結果エントリの数。
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:SearchResponse",
            "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/Map Object Class Transformation SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object オブジェクト・クラス変換のマップのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Map Object Class Transformation SearchResultEntry"
    }
}

ネストされたスキーマ: オブジェクト・クラス変換のマップのSearchResultEntry

型: object

ソースを表示

attributes: object オブジェクト・クラス変換のマップのプロパティ
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/Map Object Class Transformation Properties"
        }
    }
}

ネストされたスキーマ: オブジェクト・クラス変換のマップのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-add-attribute(optional): array ds-cfg-add-attribute

追加操作中にエントリに属性を追加します。オプションでオブジェクト・クラス名を指定して、そのオブジェクト・クラスにのみ属性を追加することができます。
ds-cfg-entry-match-filter(optional): string

この変換を適用するためにエントリが一致する必要があるフィルタを指定します。
ds-cfg-entry-parent-suffix(optional): array ds-cfg-entry-parent-suffix

この変換が適用される操作DNの祖先を指定します。
ds-cfg-excluded-operation(optional): array ds-cfg-excluded-operation

この変換が適用されない操作を指定します。これにより、この変換の標準動作を制限できます。
ds-cfg-filter-attribute(optional): array ds-cfg-filter-attribute

追加、変更操作中にエントリから、および返されたすべてのエントリから、属性を削除します。条件付きのオブジェクト・クラス名を指定して、そのオブジェクト・クラスの属性のみを削除することができます。
ds-cfg-filter-objectclass-on-modify(optional): boolean

デフォルト値: true

変更操作中にオブジェクト・クラスを削除します。
ds-cfg-filter-objectclass-on-write(optional): array ds-cfg-filter-objectclass-on-write

追加および変更操作中にオブジェクト・クラスを削除します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.core.transformations.attributetransformations.MapObjectClass

オブジェクト・クラス変換のマップの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-map-attribute(optional): array ds-cfg-map-attribute

クライアント属性をソース属性にマップします。
ds-cfg-map-objectclass: array ds-cfg-map-objectclass

クライアント・オブジェクト・クラスをソース・オブジェクト・クラスにマップします。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-map-objectclass"
    ],
    "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-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the Map Object Class Transformation implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.transformations.attributetransformations.MapObjectClass",
            "type":"string"
        },
        "ds-cfg-add-attribute":{
            "description":"Add an attribute to the entry during add operation. An optional objectclass name may be specified to add the attribute only for that objectclass. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-filter-objectclass-on-modify":{
            "description":"Remove objectclasses during modify operations. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-entry-match-filter":{
            "description":"Specifies the filter that the entry must match for this transformation to apply. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-map-attribute":{
            "description":"Map a client attribute to a source attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-excluded-operation":{
            "description":"Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-entry-parent-suffix":{
            "description":"Specifies an ascendant of the operation DN for this transformation to apply. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-filter-attribute":{
            "description":"Removes an attribute from the entry during add, modify operations and from all returned entries. A conditional objectclass name may be specified to remove the attribute only for that objectclass. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-filter-objectclass-on-write":{
            "description":"Remove an objectclass during add and modify operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-map-objectclass":{
            "description":"Map a client objectclass to a source objectclass. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-add-attribute

型: array

追加操作中にエントリに属性を追加します。オプションでオブジェクト・クラス名を指定して、そのオブジェクト・クラスにのみ属性を追加することができます。

ソースを表示

[0]: string

{
    "description":"Add an attribute to the entry during add operation. An optional objectclass name may be specified to add the attribute only for that objectclass. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-entry-parent-suffix

型: array

この変換が適用される操作DNの祖先を指定します。

ソースを表示

[0]: string

{
    "description":"Specifies an ascendant of the operation DN for this transformation to apply. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-excluded-operation

型: array

この変換が適用されない操作を指定します。これにより、この変換の標準動作を制限できます。

指定可能な値: [ "add", "compare", "delete", "extended", "modify", "modifydn", "search" ]

ソースを表示

[0]: string

{
    "description":"Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

ネストされたスキーマ: ds-cfg-filter-attribute

型: array

追加、変更操作中にエントリから、および返されたすべてのエントリから、属性を削除します。条件付きのオブジェクト・クラス名を指定して、そのオブジェクト・クラスの属性のみを削除することができます。

ソースを表示

[0]: string

{
    "description":"Removes an attribute from the entry during add, modify operations and from all returned entries. A conditional objectclass name may be specified to remove the attribute only for that objectclass. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-filter-objectclass-on-write

型: array

追加および変更操作中にオブジェクト・クラスを削除します。

ソースを表示

[0]: string

{
    "description":"Remove an objectclass during add and modify operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-map-attribute

型: array

クライアント属性をソース属性にマップします。

ソースを表示

[0]: string

{
    "description":"Map a client attribute to a source attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-map-objectclass

型: array

クライアント・オブジェクト・クラスをソース・オブジェクト・クラスにマップします。

ソースを表示

[0]: string

{
    "description":"Map a client objectclass to a source objectclass. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

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

先頭に戻る