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/Secondary Fork Join Participant 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-enabled-operation(optional): array ds-cfg-enabled-operation

この参加要素は、このパラメータで指定されているこれらのLDAP操作にのみ参加します。デフォルトでは、SEARCH、COMPARE、DELETEおよびMODIFY操作にのみ参加します。BIND操作が有効な操作として指定されている場合、構成済のバインド優先度が優先されます。それ以外の場合、優先されません。
ds-cfg-join-condition(optional): string

この参加要素で結合条件が定義されている場合は、その条件を満たすエントリのみが結合の対象になります。これは、LDAPFilter構文のものです。
ds-cfg-join-policy: string

デフォルト値: left-outer-join

指定可能な値: [ "full-outer-join", "left-outer-join", "standard-join" ]

どのエントリが検索操作から返されるかを決定する、この分岐結合WorkflowElementの結合ポリシー構成。これは、データベース結合と類似しています。1) standard-join 2) left-outer-join 3) full-outer-joinのいずれかを指定できます。
ds-cfg-joiner-type: string

デフォルト値: one-to-one

指定可能な値: [ "many-to-one", "one-to-many", "one-to-one", "shadow" ]

参加要素構成で定義されている、2つの参加要素を結合するために使用されるジョイナ・タイプ。次のいずれかになります 1OneToOne 2.OneToMany 3.ManyToOne 4.Shadow
ds-cfg-non-retrievable-attribute(optional): array ds-cfg-non-retrievable-attribute

この参加要素の取得不可属性のリストを定義します
ds-cfg-non-storable-attribute(optional): array ds-cfg-non-storable-attribute

この参加要素の格納不可属性のリストを定義します。これは、格納可能リストをオーバーライドします。
ds-cfg-participant-bind-priority(optional): integer(int32)

デフォルト値: 0

BINDがこの参加要素で有効な操作として指定されている場合に、バインド・リクエストに対応する際のこの参加要素の優先度を決定します。ゼロ以上の任意の値を使用できます。数値が大きくなるほど優先度は低くなり、数値が小さくなるほど優先度は高くなり、0は最も高い優先度となります。
ds-cfg-participant-criticality(optional): string

デフォルト値: true

指定可能な値: [ "false", "partial", "true" ]

通信エラーにより、参加要素に対して実行された検索操作が失敗した場合、結合WorkflowElementは、クリティカル度の設定に基づいて動作します。true、false、partialのいずれかの値に設定できます。クリティカル度は、検索操作でのみ適用されます。
ds-cfg-participant-dn: string

参加しているワークフロー要素によって公開される実DN
ds-cfg-participants-join-rule: string

デフォルト値:

プライマリとセカンダリの参加要素間で定義される結合ルール。それらの間でエントリを結合するために使用されます。AND/OR/NOTで組み合された複数のコンポーネントを含むLDAPFilter構文で構成され、各コンポーネントの形式は[attributeName]=[attributeName]であり、右の[attributeName]はプライマリ参加要素を指し、左の[attributeName]はセカンダリ参加要素を指します。[attributeName]は、実際の値で置換されます。
ds-cfg-participating-workflow-element: string

参加しているワークフロー要素の名前
ds-cfg-retrievable-attribute(optional): array ds-cfg-retrievable-attribute

この参加要素の取得可能属性のリストを定義します
ds-cfg-storable-attribute(optional): array ds-cfg-storable-attribute

この参加要素の格納可能属性のリストを定義します
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-participating-workflow-element",
        "ds-cfg-participants-join-rule",
        "ds-cfg-join-policy",
        "ds-cfg-participant-dn",
        "ds-cfg-joiner-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-join-condition":{
            "description":"Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participating-workflow-element":{
            "description":"Name of the Participating WorkFlow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-non-storable-attribute":{
            "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-operation":{
            "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
            "readOnly":false,
            "default":[
                "search",
                "compare",
                "delete",
                "modify"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participants-join-rule":{
            "description":"The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-participant-bind-priority":{
            "description":"Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-policy":{
            "description":"The Join policy configuration for this Fork Join WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join ",
            "readOnly":false,
            "default":"left-outer-join",
            "type":"string",
            "enum":[
                "full-outer-join",
                "left-outer-join",
                "standard-join"
            ]
        },
        "ds-cfg-non-retrievable-attribute":{
            "description":"Defines the list of non-retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-joiner-type":{
            "description":"The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow ",
            "readOnly":false,
            "default":"one-to-one",
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one",
                "shadow"
            ]
        },
        "ds-cfg-retrievable-attribute":{
            "description":"Defines the list of retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-criticality":{
            "description":"When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        }
    }
}

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

型: array

この参加要素は、このパラメータで指定されているこれらのLDAP操作にのみ参加します。デフォルトでは、SEARCH、COMPARE、DELETEおよびMODIFY操作にのみ参加します。BIND操作が有効な操作として指定されている場合、構成済のバインド優先度が優先されます。それ以外の場合、優先されません。

デフォルト値: [ "search", "compare", "delete", "modify" ]

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

ソースを表示

[0]: string

{
    "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
    "readOnly":false,
    "default":[
        "search",
        "compare",
        "delete",
        "modify"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "modify",
        "modifydn",
        "search"
    ]
}

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

型: array

この参加要素の取得不可属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of non-retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の格納不可属性のリストを定義します。これは、格納可能リストをオーバーライドします。

ソースを表示

[0]: string

{
    "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の取得可能属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の格納可能属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of storable attributes for this participant ",
    "readOnly":false,
    "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/Secondary Fork Join Participant 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/Secondary Fork Join Participant 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/Secondary Fork Join Participant Properties"
        }
    }
}

ネストされたスキーマ: セカンダリ分岐結合参加要素のプロパティ

型: object

ソースを表示

cn(optional): string

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

この参加要素は、このパラメータで指定されているこれらのLDAP操作にのみ参加します。デフォルトでは、SEARCH、COMPARE、DELETEおよびMODIFY操作にのみ参加します。BIND操作が有効な操作として指定されている場合、構成済のバインド優先度が優先されます。それ以外の場合、優先されません。
ds-cfg-join-condition(optional): string

この参加要素で結合条件が定義されている場合は、その条件を満たすエントリのみが結合の対象になります。これは、LDAPFilter構文のものです。
ds-cfg-join-policy: string

デフォルト値: left-outer-join

指定可能な値: [ "full-outer-join", "left-outer-join", "standard-join" ]

どのエントリが検索操作から返されるかを決定する、この分岐結合WorkflowElementの結合ポリシー構成。これは、データベース結合と類似しています。1) standard-join 2) left-outer-join 3) full-outer-joinのいずれかを指定できます。
ds-cfg-joiner-type: string

デフォルト値: one-to-one

指定可能な値: [ "many-to-one", "one-to-many", "one-to-one", "shadow" ]

参加要素構成で定義されている、2つの参加要素を結合するために使用されるジョイナ・タイプ。次のいずれかになります 1OneToOne 2.OneToMany 3.ManyToOne 4.Shadow
ds-cfg-non-retrievable-attribute(optional): array ds-cfg-non-retrievable-attribute

この参加要素の取得不可属性のリストを定義します
ds-cfg-non-storable-attribute(optional): array ds-cfg-non-storable-attribute

この参加要素の格納不可属性のリストを定義します。これは、格納可能リストをオーバーライドします。
ds-cfg-participant-bind-priority(optional): integer(int32)

デフォルト値: 0

BINDがこの参加要素で有効な操作として指定されている場合に、バインド・リクエストに対応する際のこの参加要素の優先度を決定します。ゼロ以上の任意の値を使用できます。数値が大きくなるほど優先度は低くなり、数値が小さくなるほど優先度は高くなり、0は最も高い優先度となります。
ds-cfg-participant-criticality(optional): string

デフォルト値: true

指定可能な値: [ "false", "partial", "true" ]

通信エラーにより、参加要素に対して実行された検索操作が失敗した場合、結合WorkflowElementは、クリティカル度の設定に基づいて動作します。true、false、partialのいずれかの値に設定できます。クリティカル度は、検索操作でのみ適用されます。
ds-cfg-participant-dn: string

参加しているワークフロー要素によって公開される実DN
ds-cfg-participants-join-rule: string

デフォルト値:

プライマリとセカンダリの参加要素間で定義される結合ルール。それらの間でエントリを結合するために使用されます。AND/OR/NOTで組み合された複数のコンポーネントを含むLDAPFilter構文で構成され、各コンポーネントの形式は[attributeName]=[attributeName]であり、右の[attributeName]はプライマリ参加要素を指し、左の[attributeName]はセカンダリ参加要素を指します。[attributeName]は、実際の値で置換されます。
ds-cfg-participating-workflow-element: string

参加しているワークフロー要素の名前
ds-cfg-retrievable-attribute(optional): array ds-cfg-retrievable-attribute

この参加要素の取得可能属性のリストを定義します
ds-cfg-storable-attribute(optional): array ds-cfg-storable-attribute

この参加要素の格納可能属性のリストを定義します
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-participating-workflow-element",
        "ds-cfg-participants-join-rule",
        "ds-cfg-join-policy",
        "ds-cfg-participant-dn",
        "ds-cfg-joiner-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-join-condition":{
            "description":"Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participating-workflow-element":{
            "description":"Name of the Participating WorkFlow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-non-storable-attribute":{
            "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-operation":{
            "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
            "readOnly":false,
            "default":[
                "search",
                "compare",
                "delete",
                "modify"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participants-join-rule":{
            "description":"The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-participant-bind-priority":{
            "description":"Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-policy":{
            "description":"The Join policy configuration for this Fork Join WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join ",
            "readOnly":false,
            "default":"left-outer-join",
            "type":"string",
            "enum":[
                "full-outer-join",
                "left-outer-join",
                "standard-join"
            ]
        },
        "ds-cfg-non-retrievable-attribute":{
            "description":"Defines the list of non-retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-joiner-type":{
            "description":"The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow ",
            "readOnly":false,
            "default":"one-to-one",
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one",
                "shadow"
            ]
        },
        "ds-cfg-retrievable-attribute":{
            "description":"Defines the list of retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-criticality":{
            "description":"When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        }
    }
}

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

型: array

デフォルト値: [ "search", "compare", "delete", "modify" ]

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

ソースを表示

[0]: string

{
    "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
    "readOnly":false,
    "default":[
        "search",
        "compare",
        "delete",
        "modify"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "modify",
        "modifydn",
        "search"
    ]
}

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

型: array

この参加要素の取得不可属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of non-retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の格納不可属性のリストを定義します。これは、格納可能リストをオーバーライドします。

ソースを表示

[0]: string

{
    "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の取得可能属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の格納可能属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of storable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "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/Secondary Fork Join Participant SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object セカンダリ分岐結合参加要素のSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Secondary Fork Join Participant 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/Secondary Fork Join Participant Properties"
        }
    }
}

ネストされたスキーマ: セカンダリ分岐結合参加要素のプロパティ

型: object

ソースを表示

cn(optional): string

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

この参加要素は、このパラメータで指定されているこれらのLDAP操作にのみ参加します。デフォルトでは、SEARCH、COMPARE、DELETEおよびMODIFY操作にのみ参加します。BIND操作が有効な操作として指定されている場合、構成済のバインド優先度が優先されます。それ以外の場合、優先されません。
ds-cfg-join-condition(optional): string

この参加要素で結合条件が定義されている場合は、その条件を満たすエントリのみが結合の対象になります。これは、LDAPFilter構文のものです。
ds-cfg-join-policy: string

デフォルト値: left-outer-join

指定可能な値: [ "full-outer-join", "left-outer-join", "standard-join" ]

どのエントリが検索操作から返されるかを決定する、この分岐結合WorkflowElementの結合ポリシー構成。これは、データベース結合と類似しています。1) standard-join 2) left-outer-join 3) full-outer-joinのいずれかを指定できます。
ds-cfg-joiner-type: string

デフォルト値: one-to-one

指定可能な値: [ "many-to-one", "one-to-many", "one-to-one", "shadow" ]

参加要素構成で定義されている、2つの参加要素を結合するために使用されるジョイナ・タイプ。次のいずれかになります 1OneToOne 2.OneToMany 3.ManyToOne 4.Shadow
ds-cfg-non-retrievable-attribute(optional): array ds-cfg-non-retrievable-attribute

この参加要素の取得不可属性のリストを定義します
ds-cfg-non-storable-attribute(optional): array ds-cfg-non-storable-attribute

この参加要素の格納不可属性のリストを定義します。これは、格納可能リストをオーバーライドします。
ds-cfg-participant-bind-priority(optional): integer(int32)

デフォルト値: 0

BINDがこの参加要素で有効な操作として指定されている場合に、バインド・リクエストに対応する際のこの参加要素の優先度を決定します。ゼロ以上の任意の値を使用できます。数値が大きくなるほど優先度は低くなり、数値が小さくなるほど優先度は高くなり、0は最も高い優先度となります。
ds-cfg-participant-criticality(optional): string

デフォルト値: true

指定可能な値: [ "false", "partial", "true" ]

通信エラーにより、参加要素に対して実行された検索操作が失敗した場合、結合WorkflowElementは、クリティカル度の設定に基づいて動作します。true、false、partialのいずれかの値に設定できます。クリティカル度は、検索操作でのみ適用されます。
ds-cfg-participant-dn: string

参加しているワークフロー要素によって公開される実DN
ds-cfg-participants-join-rule: string

デフォルト値:

プライマリとセカンダリの参加要素間で定義される結合ルール。それらの間でエントリを結合するために使用されます。AND/OR/NOTで組み合された複数のコンポーネントを含むLDAPFilter構文で構成され、各コンポーネントの形式は[attributeName]=[attributeName]であり、右の[attributeName]はプライマリ参加要素を指し、左の[attributeName]はセカンダリ参加要素を指します。[attributeName]は、実際の値で置換されます。
ds-cfg-participating-workflow-element: string

参加しているワークフロー要素の名前
ds-cfg-retrievable-attribute(optional): array ds-cfg-retrievable-attribute

この参加要素の取得可能属性のリストを定義します
ds-cfg-storable-attribute(optional): array ds-cfg-storable-attribute

この参加要素の格納可能属性のリストを定義します
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-participating-workflow-element",
        "ds-cfg-participants-join-rule",
        "ds-cfg-join-policy",
        "ds-cfg-participant-dn",
        "ds-cfg-joiner-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-join-condition":{
            "description":"Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participating-workflow-element":{
            "description":"Name of the Participating WorkFlow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-non-storable-attribute":{
            "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-operation":{
            "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
            "readOnly":false,
            "default":[
                "search",
                "compare",
                "delete",
                "modify"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participants-join-rule":{
            "description":"The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-participant-bind-priority":{
            "description":"Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-policy":{
            "description":"The Join policy configuration for this Fork Join WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join ",
            "readOnly":false,
            "default":"left-outer-join",
            "type":"string",
            "enum":[
                "full-outer-join",
                "left-outer-join",
                "standard-join"
            ]
        },
        "ds-cfg-non-retrievable-attribute":{
            "description":"Defines the list of non-retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-joiner-type":{
            "description":"The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow ",
            "readOnly":false,
            "default":"one-to-one",
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one",
                "shadow"
            ]
        },
        "ds-cfg-retrievable-attribute":{
            "description":"Defines the list of retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-criticality":{
            "description":"When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        }
    }
}

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

型: array

デフォルト値: [ "search", "compare", "delete", "modify" ]

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

ソースを表示

[0]: string

{
    "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
    "readOnly":false,
    "default":[
        "search",
        "compare",
        "delete",
        "modify"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "modify",
        "modifydn",
        "search"
    ]
}

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

型: array

この参加要素の取得不可属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of non-retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の格納不可属性のリストを定義します。これは、格納可能リストをオーバーライドします。

ソースを表示

[0]: string

{
    "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の取得可能属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

この参加要素の格納可能属性のリストを定義します

ソースを表示

[0]: string

{
    "description":"Defines the list of storable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "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."
        }
    }
}

先頭に戻る