List sender IDs (POST /)
Lists the registered sender IDs of a customer account for the specified type of sender ID (email address or domain).
Lists sender IDs regardless of verification status.
Request Headers
Refer to "Common API request headers".
Request parameters
Action
Name of the API to run.
"ListIdentities"
Data Type | Cardinality |
---|---|
String | 1..1 |
Version
API version.
"v1.0" (optional)
Data Type | Cardinality |
---|---|
String | 0..1 |
IdentityType
Type of sender ID to list.
- EmailAddress
- Domain
Data Type | Cardinality |
---|---|
String | 0..1 |
MaxItems
Maximum number of records that can be listed.
Specify up to 100.
Data Type | Cardinality |
---|---|
int | 0..1 |
NextToken
Token for retrieving data that could not be retrieved in the previous call.
Set the value returned by the response.
Data Type | Cardinality |
---|---|
String | 0..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
- 200:
- Normal completion
- 400:
- Request parameter error
- 401:
- Authentication error
- 403:
- Access denied
- 500:
- Internal error
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response elements (normal completion)
ListIdentitiesResponse
Envelope of the response.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | None | ListIdentitiesResult ResponseMetadata |
ListIdentitiesResult
Envelope of the result.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | ListIdentitiesResponse | Identities NextToken |
Identities
Envelope of the sender ID.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | ListIdentitiesResult | member |
member
Sender ID.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..n | Identities | None |
NextToken
Token for retrieving the next set of records.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | ListIdentitiesResult | None |
ResponseMetadata
Envelope of the metadata.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | ListIdentitiesResponse | RequestId |
RequestId
ID that uniquely identifies the request.
This is required when contacting support staff to troubleshoot an issue.
UUID format (example: 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 AM 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>