ジャンプ先

• リクエスト
• レスポンス

DNによるSMTPアラート・ハンドラの変更

PATCH

/rest/v1/admin/{dn}

DNによるSMTPアラート・ハンドラの変更

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• dn(required): string
  変更するエントリのLDAP DN。

本文 ()

変更する必要があるSMTPアラート・ハンドラ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations(必須): array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

LDAP変更操作のためにサーバーに送信するLDAP制御。

ソースを表示

• 配列: 文字列

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: object

ソースを表示

• attribute(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: SMTPアラート・ハンドラのPatchSuccessResponse

型: object

ソースを表示

• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): 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:ModifyResponse",
            "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/SMTP Alert Handler SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト SMTPアラート・ハンドラのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/SMTP Alert Handler SearchResultEntry"
    }
}

ネストされたスキーマ: SMTPアラート・ハンドラのSearchResultEntry

型: object

ソースを表示

• attributes(required): object SMTPアラート・ハンドラのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/SMTP Alert Handler Properties"
        }
    }
}

ネストされたスキーマ: SMTPアラート・ハンドラのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-disabled-alert-type: array ds-cfg-disabled-alert-type
  このアラート・ハンドラに対して使用不可になっているアラート・タイプの名前を指定します。
• ds-cfg-enabled(required): boolean
  アラート・ハンドラが使用可能かどうかを示します。
• ds-cfg-enabled-alert-type: array ds-cfg-enabled-alert-type
  このアラート・ハンドラに対して使用可能なアラート・タイプの名前を指定します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.extensions.SMTPAlertHandler

  SMTPアラート・ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-message-body(required): string
  このアラート・ハンドラによって生成される電子メール・メッセージで使用される本文を指定します。
• ds-cfg-message-subject(required): string
  このアラート・ハンドラによって生成される電子メール・メッセージで使用される件名を指定します。
• ds-cfg-recipient-address(required): array ds-cfg-recipient-address
  メッセージが送信される電子メール・アドレスを指定します。
• ds-cfg-sender-address(required): string
  このアラート・ハンドラによって生成されるメッセージの送信者として使用する電子メール・アドレスを指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-sender-address",
        "ds-cfg-message-body",
        "ds-cfg-recipient-address",
        "ds-cfg-enabled",
        "ds-cfg-message-subject"
    ],
    "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 SMTP Alert Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.SMTPAlertHandler",
            "type":"string"
        },
        "ds-cfg-sender-address":{
            "description":"Specifies the email address to use as the sender for messages generated by this alert handler. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-message-body":{
            "description":"Specifies the body that should be used for email messages generated by this alert handler. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-recipient-address":{
            "description":"Specifies an email address to which the messages should be sent. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-alert-type":{
            "description":"Specifies the names of the alert types that are enabled for this alert handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Alert Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-disabled-alert-type":{
            "description":"Specifies the names of the alert types that are disabled for this alert handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-message-subject":{
            "description":"Specifies the subject that should be used for email messages generated by this alert handler. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

ネストされたスキーマ: ds-cfg-disabled-alert-type

型: array

このアラート・ハンドラに対して使用不可になっているアラート・タイプの名前を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the names of the alert types that are disabled for this alert handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このアラート・ハンドラに対して使用可能なアラート・タイプの名前を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the names of the alert types that are enabled for this alert handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-recipient-address

型: array

メッセージが送信される電子メール・アドレスを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies an email address to which the messages should be sent. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): 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."
        }
    }
}

先頭に戻る