本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> ESS> GetIdentityVerificationAttributes

GetIdentityVerificationAttributes

処理概要

送信元ID(メールアドレスまたはドメイン。混在可)をリストで指定すると、それぞれに関する現在の検証状況および、ドメインの場合には検証トークンを返します。

指定するパラメーター

パラメーター 説明 必須
Identities.member.n string IDのリスト。
使用可能文字: 最大255文字。
nは1〜100までで必要な件数まで設定できる。
値はドメイン形式もしくはメールアドレス形式で指定する。

応答フィールド

フィールド (項目) 説明
GetIdentityVerificationAttributesResponse structure ルート
GetIdentityVerificationAttributesResult structure 結果
VerificationAttributes list IDの検証関連属性情報のリスト
entry structure IDの検証関連属性情報
key string ID (ドメイン名もしくは電子メールアドレス)
value structure 属性情報
VerificationStatus string IDの検証状況
値:
  • Pending (検証中)
  • Success (成功)
  • Failed (失敗)
  • TemporaryFailure (一時的な障害)
  • NotStarted (検証開始前)
VerificationToken string ドメインの検証トークン
ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
MalformedInput Sender 400 パラメーターが不正です。
InvalidParameterValue Sender 400 無効な値または範囲外の値を入力パラメーターに指定しています。

リクエストサンプル

    POST / HTTP/1.1
Authorization: NIFTY4-HMAC-SHA256 Credential=<Credential>/20140320/east-1/email/nifty4_request, SignedHeaders=content-type;host;x-nifty-date, Signature=<Signature>
Host: ess.api.nifcloud.com
Content-type: application/x-www-form-urlencoded
X-Nifty-Date: 20140320T105924Z
Content-Length: 261

Action=GetIdentityVerificationAttributes&Identities.member.1=localpart001%40example.com&Version=2010-12-01N2014-05-28

  

応答サンプル

    HTTP/1.1 200 OK
Date: Thu, 20 Mar 2014 10:59:24 GMT
x-amzn-RequestId: c3e1abd6-2782-4b80-b723-6e7437a6cfa5
X-Nifty-RequestId: c3e1abd6-2782-4b80-b723-6e7437a6cfa5
Content-Type: text/xml
Content-Length: 1155
Connection: close

<GetIdentityVerificationAttributesResponse>
<GetIdentityVerificationAttributesResult>
  <VerificationAttributes>
    <entry>
      <key>localpart001@example.com</key>
      <value>
      <VerificationStatus>Success</VerificationStatus>
      </value>
    </entry>
  </VerificationAttributes>
</GetIdentityVerificationAttributesResult>
<ResponseMetadata>
  <RequestId>c3e1abd6-2782-4b80-b723-6e7437a6cfa5</RequestId>
</ResponseMetadata>
</GetIdentityVerificationAttributesResponse>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

推奨画面サイズ 1024×768 以上