送信元IDの検証状況と検証トークンの取得 (POST /)
指定された送信元ID(メールアドレスまたはドメイン)リストに対する検証状況と認証トークン(ドメインの場合)を取得します。
送信元IDの検証状況には以下の種類があります。
- Pending(検証中)
- Success(成功)
- Failed(失敗)
- TemporaryFailure(一時的な障害)
- NotStarted(検証開始前)
Request Headers
「API共通リクエストヘッダー」を参照。
Request Parameter
Action
実行するAPI名。
"GetIdentityVerificationAttributes"
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Version
APIバージョン。
"v1.0"（任意）
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Identities.member.N
送信元ID(メールアドレスまたはドメイン)のリスト。
最大255文字。
Nは1～100まで設定可能。
| Data Type | Cardinality |
|---|---|
| String list | 1..n |
Request Elements
なし
HTTPステータス
ステータス
リクエストのステータスを返却する。
以下の値を返却する。
- 200:
- 正常終了
- 400:
- リクエストのパラメーターエラー
- 401:
- 認証エラー
- 403:
- アクセス拒否
- 500:
- 内部エラー
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements （正常終了時）
GetIdentityVerificationAttributesResponse
レスポンスのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | GetIdentityVerificationAttributesResult
ResponseMetadata |
GetIdentityVerificationAttributesResult
結果のエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | GetIdentityVerificationAttributesResponse | VerificationAttributes |
VerificationAttributes
検証状況リストのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | GetIdentityVerificationAttributesResult | entry |
entry
検証状況のエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 0..n | VerificationAttributes | key
value |
key
ID (ドメイン名もしくは電子メールアドレス)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | entry | None |
value
属性情報のエンベロープ
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | entry | VerificationStatus
VerificationToken |
VerificationStatus
送信元ID(メールアドレスまたはドメイン)の検証状況。
以下の種類があります。
- Pending(検証中)
- Success(成功)
- Failed(失敗)
- TemporaryFailure(一時的な障害)
- NotStarted(検証開始前)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | value | None |
VerificationToken
送信元ID(ドメイン)の検証トークン。
送信元IDがメールアドレスの場合はnull。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 0..1 | value | None |
ResponseMetadata
メタデータのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | GetIdentityVerificationAttributesResponse | RequestId |
RequestId
リクエストを一意に識別するID。
問題が発生した場合の問い合わせの際にトラブルシューティングを行うために必要です。
UUID形式 例：647cd254-e0d1-44a9-af61-1d6d86ea6b77
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | ResponseMetadata | None |
Example of Request
POST / HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 GMT
Content-Length: …
Host: mail.jp-east-1.tps5.fujitsu.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY…
Action=GetIdentityVerificationAttributes
&Identities.member.1=example.com
&Identities.member.2=user%40example.com
Example of Response
HTTP/1.1 200 OK
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: …
Content-Type: application/xml
x-fj-request-id: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6
<?xml version="1.0" encoding="UTF-8"?>
<GetIdentityVerificationAttributesResponse>
<GetIdentityVerificationAttributesResult>
<VerificationAttributes>
<entry>
<key>example.com</key>
<value>
<VerificationStatus>Pending</VerificationStatus>
<VerificationToken>QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=</VerificationToken>
</value>
</entry>
<entry>
<key>user@ example.com</key>
<value>
<VerificationStatus>Pending</VerificationStatus>
</value>
</entry>
</VerificationAttributes>
</GetIdentityVerificationAttributesResult>
<ResponseMetadata>
<RequestId>d96bd874-9bf2-11e1-8ee7-c98a0037a2b6</RequestId>
</ResponseMetadata>
</GetIdentityVerificationAttributesResponse>