auth.v1.SubaccountService
ListSubaccountMembers
List current members for a sub-account visible to any current member.
Method
POST
Path
auth.v1.SubaccountService/ListSubaccountMembers
Service
auth.v1.SubaccountService
Visibility
Authentication
Session token
MFA Requirement
Not required
POST
auth.v1.SubaccountService/ListSubaccountMembers Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.SubaccountService/ListSubaccountMembers' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"subaccountId": "6789012345678"
}'Responses
{
"members": [
{
"accountId": "7563897446546",
"avatarUrl": "https://placehold.co/128x128.png",
"mfaEnrolled": false,
"role": "VIEWER",
"smartAccountAddress": "0x2222222222222222222222222222222222222222",
"username": "trader_alpha"
}
]
}Request
auth.v1.ListSubaccountMembersRequestResponse
auth.v1.ListSubaccountMembersResponse subaccountId string (fixed64)
Sub-account to inspect (opaque ID).
6 fields
accountId string (fixed64)
Identifier for the member's root account (opaque ID).
role enum
Effective role on this sub-account.
VIEWER TRADER LEVERAGED_TRADER TREASURY ADMIN OWNER
username string
Optional username for the member's root account.
smartAccountAddress string
Smart Account address for the member's root account, if any.
avatarUrl string
Optional avatar URL for the member's root account.
mfaEnrolled boolean
True when the member has at least one MFA factor enrolled on their root account.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |