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/Fork Join Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object 分岐結合ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: 分岐結合ワークフロー要素のプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-cache-size(optional): integer(int32)

デフォルト値: 10000

エントリ重複の除外に使用されるキャッシュに格納できる最大エントリ数。
ds-cfg-dn-attribute(optional): array ds-cfg-dn-attribute

DNを分岐結合ワークフロー要素のそれに変換する必要があるDN構文属性。
ds-cfg-enabled: boolean

サーバーでワークフロー要素が使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: com.oracle.dps.server.workflowelement.forkjoin.ForkJoinWorkflowElement

分岐結合ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-join-suffix(optional): string

読取り専用: true

分岐結合ワークフロー要素によって公開される仮想DN
ds-cfg-password-attribute(optional): string

デフォルト値: userpassword

パスワードがユーザー・エントリに含まれる属性の名前を指定します。
ds-cfg-populate-joinedentrydn(optional): boolean

デフォルト値: false

属性joinedentrydnを、結合されたエントリに移入する必要があるかどうかを決定します。
ds-cfg-primary-and-secondary-attributes(optional): array ds-cfg-primary-and-secondary-attributes

プライマリ参加要素とセカンダリ参加要素の両方に存在し、アプリケーションが検索フィルタで使用できる属性のリスト。PrimaryAndSecondaryAttributes構成パラメータで指定した属性をSecondaryOnlyAttributes構成パラメータでも指定することはできません。
ds-cfg-save-password-on-successful-bind(optional): boolean

デフォルト値: false

認証が成功した場合にパスワードをプライマリ・エントリに保存する必要があるかどうかを示します。
ds-cfg-secondary-only-attributes(optional): array ds-cfg-secondary-only-attributes

セカンダリ参加要素にのみ存在し、アプリケーションが検索フィルタで使用できる属性のリスト。SecondaryOnlyAttributes構成パラメータで指定した属性をPrimaryAndSecondaryAttributes構成パラメータでも指定することはできません。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled"
    ],
    "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 Fork Join Workflow Element implementation. ",
            "readOnly":false,
            "default":"com.oracle.dps.server.workflowelement.forkjoin.ForkJoinWorkflowElement",
            "type":"string"
        },
        "ds-cfg-dn-attribute":{
            "description":"DN syntax attributes whose DN need to be translated to that of Fork Join Workflow Element. ",
            "readOnly":false,
            "default":[
                "member",
                "uniquemember",
                "memberof",
                "manager"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-primary-and-secondary-attributes":{
            "description":"A list of attributes that are present in both the primary and secondary participants and which the application can use in the search filter. The attributes identified by the PrimaryAndSecondaryAttributes configuration parameter cannot also be identified by the SecondaryOnlyAttributes configuration parameter. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-secondary-only-attributes":{
            "description":"A list of attributes that are present only in the secondary participant and which the application can use in the search filter. The attributes identified by the SecondaryOnlyAttributes configuration parameter cannot also be identified by the PrimaryAndSecondaryAttributes configuration parameter. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-size":{
            "description":"The maximum number of entries that can be stored in the cache used to filter out entry duplicates. ",
            "readOnly":false,
            "default":10000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-suffix":{
            "description":"The virtual DN that will be exposed by the Fork Join Workflow Element ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the names of the attribute that contains the password in the user entry. ",
            "readOnly":false,
            "default":"userpassword",
            "type":"string"
        },
        "ds-cfg-save-password-on-successful-bind":{
            "description":"Indicates whether the password should be saved in the primary entry when authentication succeeds. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-populate-joinedentrydn":{
            "description":"Decides if the attribute \"joinedentrydn\" has to be populated in the joined entries. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

型: array

DNを分岐結合ワークフロー要素のそれに変換する必要があるDN構文属性。

デフォルト値: [ "member", "uniquemember", "memberof", "manager" ]

ソースを表示

[0]: string

{
    "description":"DN syntax attributes whose DN need to be translated to that of Fork Join Workflow Element. ",
    "readOnly":false,
    "default":[
        "member",
        "uniquemember",
        "memberof",
        "manager"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-primary-and-secondary-attributes

型: array

プライマリ参加要素とセカンダリ参加要素の両方に存在し、アプリケーションが検索フィルタで使用できる属性のリスト。PrimaryAndSecondaryAttributes構成パラメータで指定した属性をSecondaryOnlyAttributes構成パラメータでも指定することはできません。

ソースを表示

[0]: string

{
    "description":"A list of attributes that are present in both the primary and secondary participants and which the application can use in the search filter. The attributes identified by the PrimaryAndSecondaryAttributes configuration parameter cannot also be identified by the SecondaryOnlyAttributes configuration parameter. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-secondary-only-attributes

型: array

セカンダリ参加要素にのみ存在し、アプリケーションが検索フィルタで使用できる属性のリスト。SecondaryOnlyAttributes構成パラメータで指定した属性をPrimaryAndSecondaryAttributes構成パラメータでも指定することはできません。

ソースを表示

[0]: string

{
    "description":"A list of attributes that are present only in the secondary participant and which the application can use in the search filter. The attributes identified by the SecondaryOnlyAttributes configuration parameter cannot also be identified by the PrimaryAndSecondaryAttributes configuration parameter. ",
    "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."
        }
    }
}

先頭に戻る