ジャンプ先

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

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 Account Status Notification Handler SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト SMTPアカウント・ステータス通知ハンドラのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/SMTP Account Status Notification 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 Account Status Notification Handler Properties"
        }
    }
}

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

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-email-address-attribute-type: array ds-cfg-email-address-attribute-type
  エンド・ユーザーに通知する際、電子メール・アドレスの取得にユーザーのエントリのどの属性を使用できるかを指定します。
• ds-cfg-enabled(required): boolean
  アカウント・ステータス通知ハンドラが使用可能かどうかを示します。サーバーで関連のあるイベントが発生したときは、常に、有効なハンドラのみが呼び出されます。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.extensions.SMTPAccountStatusNotificationHandler

  SMTPアカウント・ステータス通知ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-message-subject(required): array ds-cfg-message-subject
  このアカウント・ステータス通知ハンドラによって生成される電子メール・メッセージで使用される件名を指定します。
• ds-cfg-message-template-file(required): array ds-cfg-message-template-file
  電子メール通知メッセージを生成するためのメッセージ・テンプレートを含むファイルのパスを指定します。
• ds-cfg-recipient-address: array ds-cfg-recipient-address
  通知の生成対象となったエンド・ユーザーのかわりに、またはそのエンド・ユーザーに追加して、通知メッセージを送信する電子メール・アドレスを指定します。
• ds-cfg-send-message-without-end-user-address(required): boolean
  デフォルト値: true

  ユーザー・エントリのどの電子メール・アドレス属性にも値が含まれていない場合(つまり、エンド・ユーザーに通知できない場合)でも、一連の通知受信者に対して電子メール通知メッセージを生成して送信する必要があるかどうかを示します。
• 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-template-file",
        "ds-cfg-enabled",
        "ds-cfg-send-message-without-end-user-address",
        "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 Account Status Notification Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.SMTPAccountStatusNotificationHandler",
            "type":"string"
        },
        "ds-cfg-sender-address":{
            "description":"Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-email-address-attribute-type":{
            "description":"Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-recipient-address":{
            "description":"Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-message-template-file":{
            "description":"Specifies the path to the file containing the message template to generate the email notification messages. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-send-message-without-end-user-address":{
            "description":"Indicates whether an email notification message should be generated and sent to the set of notification recipients even if the user entry does not contain any values for any of the email address attributes (that is, in cases when it is not be possible to notify the end user). ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-message-subject":{
            "description":"Specifies the subject that should be used for email messages generated by this account status notification handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-email-address-attribute-type

型: array

エンド・ユーザーに通知する際、電子メール・アドレスの取得にユーザーのエントリのどの属性を使用できるかを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-message-subject

型: array

このアカウント・ステータス通知ハンドラによって生成される電子メール・メッセージで使用される件名を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the subject that should be used for email messages generated by this account status notification handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-message-template-file

型: array

電子メール通知メッセージを生成するためのメッセージ・テンプレートを含むファイルのパスを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the path to the file containing the message template to generate the email notification messages. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

通知の生成対象となったエンド・ユーザーのかわりに、またはそのエンド・ユーザーに追加して、通知メッセージを送信する電子メール・アドレスを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated. ",
    "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."
        }
    }
}

先頭に戻る