Oracle Unified Directoryの管理REST API: オブジェクト・クラス・マッピングの追加、検索、比較または削除

オブジェクト・クラス・マッピングの追加、検索、比較または削除

POST

/rest/v1/admin

オブジェクト・クラス・マッピングの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要があるオブジェクト・クラス・マッピング

ルート・スキーマ: オブジェクト・クラス・マッピングのPOSTRequest

型: object

ソースを表示

assertion(optional): string

LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes(optional): object オブジェクト・クラス・マッピングのプロパティ
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/Objectclass Mapping 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(optional): string

エントリのCN (共通名)
ds-cfg-objectclass-name: string

オブジェクト・クラス・マッピングによって生成されるエントリのLDAPオブジェクト・クラス名。オブジェクト・クラスがサーバー・スキーマに定義されていない場合、サーバーの起動時にサーバー・スキーマに自動的に追加されます。すでに存在する場合は、追加されません。スキーマにより特定のオブジェクト・クラスのエントリを定義するために存在する必要がある、または存在している可能性のある属性は関係なく、これは、属性マッピング管理対象オブジェクトを通じて、エントリによって必要とされる属性をユーザーが明示的に定義する必要があるためです。
ds-cfg-rdn-attribute: string

このプロパティは、オブジェクト・クラス・マッピングに属するエントリのDNを構築するために必要なRDN属性のシーケンスを定義します。属性のシーケンスは、カンマ区切りのリストとして指定されます。たとえば、値は1) cn 2) cn,o 3) uid+cn+sn,oとなります。エントリのDNは、属性値のRDN属性への移入およびオブジェクト・クラス・マッピングが属するRDBMSワークフロー要素の接尾辞DNへの連結によって構築されます。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

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

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

型: array

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

ソースを表示

[0]: string

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: オブジェクト・クラス・マッピングの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/Objectclass Mapping SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

[0]: object オブジェクト・クラス・マッピングのSearchResultEntry

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

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

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-objectclass-name: string

オブジェクト・クラス・マッピングによって生成されるエントリのLDAPオブジェクト・クラス名。オブジェクト・クラスがサーバー・スキーマに定義されていない場合、サーバーの起動時にサーバー・スキーマに自動的に追加されます。すでに存在する場合は、追加されません。スキーマにより特定のオブジェクト・クラスのエントリを定義するために存在する必要がある、または存在している可能性のある属性は関係なく、これは、属性マッピング管理対象オブジェクトを通じて、エントリによって必要とされる属性をユーザーが明示的に定義する必要があるためです。
ds-cfg-rdn-attribute: string

このプロパティは、オブジェクト・クラス・マッピングに属するエントリのDNを構築するために必要なRDN属性のシーケンスを定義します。属性のシーケンスは、カンマ区切りのリストとして指定されます。たとえば、値は1) cn 2) cn,o 3) uid+cn+sn,oとなります。エントリのDNは、属性値のRDN属性への移入およびオブジェクト・クラス・マッピングが属するRDBMSワークフロー要素の接尾辞DNへの連結によって構築されます。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

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

型: array

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

ソースを表示

[0]: string

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

201レスポンス

作成済

ルート・スキーマ: オブジェクト・クラス・マッピングの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/Objectclass Mapping SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object オブジェクト・クラス・マッピングのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Objectclass Mapping 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/Objectclass Mapping Properties"
        }
    }
}

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

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-objectclass-name: string

オブジェクト・クラス・マッピングによって生成されるエントリのLDAPオブジェクト・クラス名。オブジェクト・クラスがサーバー・スキーマに定義されていない場合、サーバーの起動時にサーバー・スキーマに自動的に追加されます。すでに存在する場合は、追加されません。スキーマにより特定のオブジェクト・クラスのエントリを定義するために存在する必要がある、または存在している可能性のある属性は関係なく、これは、属性マッピング管理対象オブジェクトを通じて、エントリによって必要とされる属性をユーザーが明示的に定義する必要があるためです。
ds-cfg-rdn-attribute: string

このプロパティは、オブジェクト・クラス・マッピングに属するエントリのDNを構築するために必要なRDN属性のシーケンスを定義します。属性のシーケンスは、カンマ区切りのリストとして指定されます。たとえば、値は1) cn 2) cn,o 3) uid+cn+sn,oとなります。エントリのDNは、属性値のRDN属性への移入およびオブジェクト・クラス・マッピングが属するRDBMSワークフロー要素の接尾辞DNへの連結によって構築されます。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

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

先頭に戻る