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/Union Workflow Element 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-auto-tune-search-option(optional): boolean

デフォルト値: false

search-first-matchプロパティがtrueに設定されている場合、!(uid=user.1)などのフィルタを使用したサブツリー検索では、通常は1つのエントリがターゲットとなります。ただし、uid=user.2やuid=user.3なども、この条件の有効な結果であるため、複数のエントリがターゲットになる必要があります。search-first-matchがtrueに設定されている場合でも、結合ワークフロー要素で、条件に一致する複数のエントリが返されるようにするには、このプロパティをtrueに設定します。
ds-cfg-base-dn(optional): string

読取り専用: true

仮想統合DITのベースDN。
ds-cfg-bind-option(optional): string

デフォルト値: bind-first-success

指定可能な値: [ "bind-first-success", "bind-quick-fail" ]

バインド・リクエストが最初に成功するまで、構成されているすべてのパーティションのリストを進んでいく必要があるか、構成されている別々のパーティションのDNが複数のユーザーで同一の場合には、失敗する必要があるかを示します。
ds-cfg-cache-size(optional): integer(int32)

デフォルト値: 10000

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

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

デフォルト値: org.opends.server.workflowelement.union.UnionWorkflowElement

結合ワークフロー要素の実装を提供するJava classの完全修飾名を指定します。
ds-cfg-search-first-match(optional): boolean

デフォルト値: true

サブツリー検索でエントリが検出されたときに処理を停止するかどうかを示します。
ds-cfg-suppress-entry-duplicates(optional): boolean

デフォルト値: false

結合ワークフロー要素でエントリ重複の抑制を試行するかどうかを示します。
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 Union Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.union.UnionWorkflowElement",
            "type":"string"
        },
        "ds-cfg-auto-tune-search-option":{
            "description":"A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "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-search-first-match":{
            "description":"Indicates if a subtree search should stop the processing once an entry is found. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-suppress-entry-duplicates":{
            "description":"Indicate whether the Union Workflow Element should try to suppress the entry duplicates. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bind-option":{
            "description":"Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions. ",
            "readOnly":false,
            "default":"bind-first-success",
            "type":"string",
            "enum":[
                "bind-first-success",
                "bind-quick-fail"
            ]
        },
        "ds-cfg-base-dn":{
            "description":"The base DN of the virtual unified DIT. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element 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/Union Workflow Element 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/Union 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/Union Workflow Element Properties"
        }
    }
}

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

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-auto-tune-search-option(optional): boolean

デフォルト値: false

search-first-matchプロパティがtrueに設定されている場合、!(uid=user.1)などのフィルタを使用したサブツリー検索では、通常は1つのエントリがターゲットとなります。ただし、uid=user.2やuid=user.3なども、この条件の有効な結果であるため、複数のエントリがターゲットになる必要があります。search-first-matchがtrueに設定されている場合でも、結合ワークフロー要素で、条件に一致する複数のエントリが返されるようにするには、このプロパティをtrueに設定します。
ds-cfg-base-dn(optional): string

読取り専用: true

仮想統合DITのベースDN。
ds-cfg-bind-option(optional): string

デフォルト値: bind-first-success

指定可能な値: [ "bind-first-success", "bind-quick-fail" ]

バインド・リクエストが最初に成功するまで、構成されているすべてのパーティションのリストを進んでいく必要があるか、構成されている別々のパーティションのDNが複数のユーザーで同一の場合には、失敗する必要があるかを示します。
ds-cfg-cache-size(optional): integer(int32)

デフォルト値: 10000

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

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

デフォルト値: org.opends.server.workflowelement.union.UnionWorkflowElement

結合ワークフロー要素の実装を提供するJava classの完全修飾名を指定します。
ds-cfg-search-first-match(optional): boolean

デフォルト値: true

サブツリー検索でエントリが検出されたときに処理を停止するかどうかを示します。
ds-cfg-suppress-entry-duplicates(optional): boolean

デフォルト値: false

結合ワークフロー要素でエントリ重複の抑制を試行するかどうかを示します。
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 Union Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.union.UnionWorkflowElement",
            "type":"string"
        },
        "ds-cfg-auto-tune-search-option":{
            "description":"A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "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-search-first-match":{
            "description":"Indicates if a subtree search should stop the processing once an entry is found. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-suppress-entry-duplicates":{
            "description":"Indicate whether the Union Workflow Element should try to suppress the entry duplicates. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bind-option":{
            "description":"Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions. ",
            "readOnly":false,
            "default":"bind-first-success",
            "type":"string",
            "enum":[
                "bind-first-success",
                "bind-quick-fail"
            ]
        },
        "ds-cfg-base-dn":{
            "description":"The base DN of the virtual unified DIT. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element 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/Union Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

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

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

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

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-auto-tune-search-option(optional): boolean

デフォルト値: false

search-first-matchプロパティがtrueに設定されている場合、!(uid=user.1)などのフィルタを使用したサブツリー検索では、通常は1つのエントリがターゲットとなります。ただし、uid=user.2やuid=user.3なども、この条件の有効な結果であるため、複数のエントリがターゲットになる必要があります。search-first-matchがtrueに設定されている場合でも、結合ワークフロー要素で、条件に一致する複数のエントリが返されるようにするには、このプロパティをtrueに設定します。
ds-cfg-base-dn(optional): string

読取り専用: true

仮想統合DITのベースDN。
ds-cfg-bind-option(optional): string

デフォルト値: bind-first-success

指定可能な値: [ "bind-first-success", "bind-quick-fail" ]

バインド・リクエストが最初に成功するまで、構成されているすべてのパーティションのリストを進んでいく必要があるか、構成されている別々のパーティションのDNが複数のユーザーで同一の場合には、失敗する必要があるかを示します。
ds-cfg-cache-size(optional): integer(int32)

デフォルト値: 10000

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

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

デフォルト値: org.opends.server.workflowelement.union.UnionWorkflowElement

結合ワークフロー要素の実装を提供するJava classの完全修飾名を指定します。
ds-cfg-search-first-match(optional): boolean

デフォルト値: true

サブツリー検索でエントリが検出されたときに処理を停止するかどうかを示します。
ds-cfg-suppress-entry-duplicates(optional): boolean

デフォルト値: false

結合ワークフロー要素でエントリ重複の抑制を試行するかどうかを示します。
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 Union Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.union.UnionWorkflowElement",
            "type":"string"
        },
        "ds-cfg-auto-tune-search-option":{
            "description":"A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "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-search-first-match":{
            "description":"Indicates if a subtree search should stop the processing once an entry is found. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-suppress-entry-duplicates":{
            "description":"Indicate whether the Union Workflow Element should try to suppress the entry duplicates. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bind-option":{
            "description":"Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions. ",
            "readOnly":false,
            "default":"bind-first-success",
            "type":"string",
            "enum":[
                "bind-first-success",
                "bind-quick-fail"
            ]
        },
        "ds-cfg-base-dn":{
            "description":"The base DN of the virtual unified DIT. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element 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."
        }
    }
}

先頭に戻る