送信元IDの一覧取得 (POST /)
送信元IDの種類(メールアドレスまたはドメイン)を指定して、お客様アカウントの登録済みの送信元IDを取得します。
すべての検証状況の送信元IDが取得されます。
Request Headers
「API共通リクエストヘッダー」を参照。
Request Parameter
Action
実行するAPI名。
"ListIdentities"
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Version
APIバージョン。
"v1.0"（任意）
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
IdentityType
取得する送信元IDの種類。
以下の種類があります。
- EmailAddress
- Domain
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
MaxItems
取得レコード最大数。
最大100まで設定可能
| Data Type | Cardinality |
|---|---|
| int | 0..1 |
NextToken
前回の呼び出し時に取得できなかったデータを取得するためのトークン。
レスポンスで返された値を設定。
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Request Elements
なし
HTTPステータス
ステータス
リクエストのステータスを返却する。
以下の値を返却する。
- 200:
- 正常終了
- 400:
- リクエストのパラメーターエラー
- 401:
- 認証エラー
- 403:
- アクセス拒否
- 500:
- 内部エラー
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements（正常終了時）
ListIdentitiesResponse
レスポンスのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | ListIdentitiesResult
ResponseMetadata |
ListIdentitiesResult
結果のエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | ListIdentitiesResponse | Identities
NextToken |
Identities
送信元IDのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | ListIdentitiesResult | member |
member
送信元ID。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 0..n | Identities | None |
NextToken
取得できなかったレコードを取得するためのトークン。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 0..1 | ListIdentitiesResult | None |
ResponseMetadata
メタデータのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | ListIdentitiesResponse | 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=ListIdentities
&IdentityType=EmailAddress
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"?>
<ListIdentitiesResponse>
<ListIdentitiesResult>
<Identities>
<member>user1@example.com</member>
<member>user2@example.com</member>
</Identities>
</ListIdentitiesResult>
<ResponseMetadata>
<RequestId>d96bd874-9bf2-11e1-8ee7-c98a0037a2b6</RequestId>
</ResponseMetadata>
</ListIdentitiesResponse>