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/Join Participant SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object 結合参加要素のSearchResultEntry

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

デフォルト値: standard-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(optional): 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-attribute(optional): array ds-cfg-participant-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(optional): string

デフォルト値:

2つの参加要素間に定義された結合ルール。このルールは、参加要素間のエントリの結合に使用されます。これは各コンポーネントの形式が[ParticipantName].[attributeName]=[ParticipantName].[attributeName]で、AND/OR/NOTと組み合せられた複数のコンポーネントを含むLDAPFilter構文の一部です。ここで、[ParticipantName]と[attributeName]は実際の値に置き換えられます。
ds-cfg-participating-workflow-element: string

参加しているワークフロー要素の名前
ds-cfg-primary-participant(optional): boolean

デフォルト値: false

この参加要素がプライマリ参加要素であることを示します。
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-participant-dn"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-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-participants-join-rule":{
            "description":"The join rule defined between two 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 [ParticipantName].[attributeName]=[ParticipantName].[attributeName], where the [ParticipantName] and [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "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 Join WorkflowElement, which decides what entries 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":"standard-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-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-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participant-attribute":{
            "description":"Defines the list of attributes, that when present in search filter, can be handled by this participant. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-primary-participant":{
            "description":"Indicates that this participant is the primary participant. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "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

この参加要素は、このパラメータで指定されているこれらの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-participant-attribute

型: array

検索フィルタに表示された際にこの参加要素によって処理される属性のリストを定義します。

ソースを表示

[0]: string

{
    "description":"Defines the list of attributes, that when present in search filter, can be handled by this participant. ",
    "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"
    }
}

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

先頭に戻る