DNによるSMTPアカウント・ステータス通知ハンドラの検索
GET
/rest/v1/admin/{dn}
DNによってSMTPアカウント・ステータス通知ハンドラを返します
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- dn: string
フェッチするエントリのLDAP DN。
問合せパラメータ
- attributes: array
- controls: array
- filter: string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
- scope: string
LDAP検索操作の範囲。指定可能な値:
[ "base", "sub", "one" ]
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: SMTPアカウント・ステータス通知ハンドラのGetSuccessResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: SMTPアカウント・ステータス通知ハンドラのSearchResultEntry
型:
ソースを表示
object
- attributes: object SMTPアカウント・ステータス通知ハンドラのプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: SMTPアカウント・ステータス通知ハンドラのプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-email-address-attribute-type(optional): array ds-cfg-email-address-attribute-type
エンド・ユーザーに通知する際、電子メール・アドレスの取得にユーザーのエントリのどの属性を使用できるかを指定します。
- ds-cfg-enabled: boolean
アカウント・ステータス通知ハンドラが使用可能かどうかを示します。サーバーで関連のあるイベントが発生したときは、常に、有効なハンドラのみが呼び出されます。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.extensions.SMTPAccountStatusNotificationHandler
SMTPアカウント・ステータス通知ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-message-subject: array ds-cfg-message-subject
このアカウント・ステータス通知ハンドラによって生成される電子メール・メッセージで使用される件名を指定します。
- ds-cfg-message-template-file: array ds-cfg-message-template-file
電子メール通知メッセージを生成するためのメッセージ・テンプレートを含むファイルのパスを指定します。
- ds-cfg-recipient-address(optional): array ds-cfg-recipient-address
通知の生成対象となったエンド・ユーザーのかわりに、またはそのエンド・ユーザーに追加して、通知メッセージを送信する電子メール・アドレスを指定します。
- ds-cfg-send-message-without-end-user-address: boolean
デフォルト値:
true
ユーザー・エントリのどの電子メール・アドレス属性にも値が含まれていない場合(つまり、エンド・ユーザーに通知できない場合)でも、一連の通知受信者に対して電子メール通知メッセージを生成して送信する必要があるかどうかを示します。 - ds-cfg-sender-address: string
メッセージの送信元の電子メール・アドレスを指定します。これは必ずしも正規の電子メール・アドレスである必要はありません。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-email-address-attribute-type
型:
array
エンド・ユーザーに通知する際、電子メール・アドレスの取得にユーザーのエントリのどの属性を使用できるかを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-message-subject
型:
array
このアカウント・ステータス通知ハンドラによって生成される電子メール・メッセージで使用される件名を指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-message-template-file
型:
array
電子メール通知メッセージを生成するためのメッセージ・テンプレートを含むファイルのパスを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-recipient-address
型:
array
通知の生成対象となったエンド・ユーザーのかわりに、またはそのエンド・ユーザーに追加して、通知メッセージを送信する電子メール・アドレスを指定します。
ソースを表示
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ