Accounts
AccountsService provides operations for managing accounts.
Base path: /accounts
POST /accounts/ListAccounts
Section titled “POST /accounts/ListAccounts”ListAccounts retrieves all accounts with pagination.
Request (ListAccountsRequest)
| Field | Type | Description |
|---|---|---|
page_size | int32? | page_size: Maximum number of accounts per page (1–1000, default 50). |
page_token | string? | page_token: Token from previous response to fetch the next page. |
Response (ListAccountsResponse)
| Field | Type | Description |
|---|---|---|
accounts | Account[] | |
next_page_token | string | next_page_token: Pass to the next request to get the following page. Empty means no more pages. |
POST /accounts/GetAccount
Section titled “POST /accounts/GetAccount”GetAccount retrieves a specific account by ID.
Request (GetAccountRequest)
| Field | Type | Description |
|---|---|---|
account_id | string |
Response (GetAccountResponse)
| Field | Type | Description |
|---|---|---|
account | Account |
POST /accounts/CreateAccount
Section titled “POST /accounts/CreateAccount”CreateAccount creates a new account for a user.
Request (CreateAccountRequest)
| Field | Type | Description |
|---|---|---|
user_id | string | user_id: The user who will own this account. |
name | string | name: Display name for the account. |
local_part | string | The primary alias for this account will be constructed as: <local_part>@<domain.domain> where domain_id refers to a configured domain in DynamoDB. |
domain_id | string | domain_id: Domain for the primary alias (must be a configured sending domain). |
Response (CreateAccountResponse)
| Field | Type | Description |
|---|---|---|
account | Account |
POST /accounts/UpdateAccount
Section titled “POST /accounts/UpdateAccount”UpdateAccount updates account properties.
Request (UpdateAccountRequest)
| Field | Type | Description |
|---|---|---|
account_id | string | |
name | string? | name: New display name for the account. |
Response (UpdateAccountResponse)
| Field | Type | Description |
|---|---|---|
account | Account |
POST /accounts/DeleteAccount
Section titled “POST /accounts/DeleteAccount”DeleteAccount deletes an account and all associated data (aliases, mailboxes, emails).
Request (DeleteAccountRequest)
| Field | Type | Description |
|---|---|---|
account_id | string |
Response (DeleteAccountResponse)
No fields.
POST /accounts/ListAccountMembers
Section titled “POST /accounts/ListAccountMembers”ListAccountMembers lists all ACL members of an account.
Request (ListAccountMembersRequest)
| Field | Type | Description |
|---|---|---|
account_id | string |
Response (ListAccountMembersResponse)
| Field | Type | Description |
|---|---|---|
members | AccountMember[] |
POST /accounts/PutAccountMember
Section titled “POST /accounts/PutAccountMember”PutAccountMember creates or updates a user’s role on an account.
Request (PutAccountMemberRequest)
| Field | Type | Description |
|---|---|---|
account_id | string | |
user_id | string | |
role | AccountRole |
Response (PutAccountMemberResponse)
| Field | Type | Description |
|---|---|---|
member | AccountMember |
POST /accounts/DeleteAccountMember
Section titled “POST /accounts/DeleteAccountMember”DeleteAccountMember removes a user from an account ACL.
Request (DeleteAccountMemberRequest)
| Field | Type | Description |
|---|---|---|
account_id | string | |
user_id | string |
Response (DeleteAccountMemberResponse)
No fields.