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/Workflow 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-access-control-group(optional): string

ワークフローで使用されるアクセス制御グループを指定します。
ds-cfg-base-dn(optional): string

読取り専用: true

ワークフローで対象となっているデータのベースDNを指定します。
ds-cfg-criticality(optional): string

デフォルト値: true

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

クリティカル度は、検索操作の実行時にワークフローに属するワークフロー要素の1つがUNAVAILABLEの結果コードを返した際、どのような動作を実行するのかを決定します。
ds-cfg-enabled: boolean

サーバーでワークフローが使用可能かどうかを示します。
ds-cfg-virtual-aci-mode(optional): boolean

デフォルト値: false

ワークフローが仮想ACIを使用するかどうかを示します。
ds-cfg-workflow-element: string

ワークフローでルートのワークフロー要素を指定します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element",
        "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-virtual-aci-mode":{
            "description":"Indicates whether the Workflow uses the virtual acis. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-workflow-element":{
            "description":"Specifies the root Workflow Element in the Workflow . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-criticality":{
            "description":"The criticality determines the behavior to adopt when one of the workflow elements belonging to a workflow returns an UNAVAILABLE result code during the execution of a search operation. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        },
        "ds-cfg-access-control-group":{
            "description":"Specifies the access control group used by the Workflow. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the data targeted by the Workflow . ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

ネストされたスキーマ: ワークフローのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-access-control-group(optional): string

ワークフローで使用されるアクセス制御グループを指定します。
ds-cfg-base-dn(optional): string

読取り専用: true

ワークフローで対象となっているデータのベースDNを指定します。
ds-cfg-criticality(optional): string

デフォルト値: true

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

クリティカル度は、検索操作の実行時にワークフローに属するワークフロー要素の1つがUNAVAILABLEの結果コードを返した際、どのような動作を実行するのかを決定します。
ds-cfg-enabled: boolean

サーバーでワークフローが使用可能かどうかを示します。
ds-cfg-virtual-aci-mode(optional): boolean

デフォルト値: false

ワークフローが仮想ACIを使用するかどうかを示します。
ds-cfg-workflow-element: string

ワークフローでルートのワークフロー要素を指定します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element",
        "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-virtual-aci-mode":{
            "description":"Indicates whether the Workflow uses the virtual acis. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-workflow-element":{
            "description":"Specifies the root Workflow Element in the Workflow . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-criticality":{
            "description":"The criticality determines the behavior to adopt when one of the workflow elements belonging to a workflow returns an UNAVAILABLE result code during the execution of a search operation. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        },
        "ds-cfg-access-control-group":{
            "description":"Specifies the access control group used by the Workflow. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the data targeted by the Workflow . ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

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

型: array

ソースを表示

[0]: object ワークフローのSearchResultEntry

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

ネストされたスキーマ: ワークフローのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-access-control-group(optional): string

ワークフローで使用されるアクセス制御グループを指定します。
ds-cfg-base-dn(optional): string

読取り専用: true

ワークフローで対象となっているデータのベースDNを指定します。
ds-cfg-criticality(optional): string

デフォルト値: true

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

クリティカル度は、検索操作の実行時にワークフローに属するワークフロー要素の1つがUNAVAILABLEの結果コードを返した際、どのような動作を実行するのかを決定します。
ds-cfg-enabled: boolean

サーバーでワークフローが使用可能かどうかを示します。
ds-cfg-virtual-aci-mode(optional): boolean

デフォルト値: false

ワークフローが仮想ACIを使用するかどうかを示します。
ds-cfg-workflow-element: string

ワークフローでルートのワークフロー要素を指定します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element",
        "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-virtual-aci-mode":{
            "description":"Indicates whether the Workflow uses the virtual acis. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-workflow-element":{
            "description":"Specifies the root Workflow Element in the Workflow . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-criticality":{
            "description":"The criticality determines the behavior to adopt when one of the workflow elements belonging to a workflow returns an UNAVAILABLE result code during the execution of a search operation. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        },
        "ds-cfg-access-control-group":{
            "description":"Specifies the access control group used by the Workflow. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the data targeted by the Workflow . ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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

先頭に戻る