auth.v1.SubaccountRoleService
ListSubaccountRoles
List the authoritative built-in role and permission catalog. This metadata is public.
Method
POST
Path
auth.v1.SubaccountRoleService/ListSubaccountRoles
Service
auth.v1.SubaccountRoleService
Visibility
Public endpoint
POST
auth.v1.SubaccountRoleService/ListSubaccountRoles Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.SubaccountRoleService/ListSubaccountRoles' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{}'Responses
{
"permissions": [
{
"description": "Example configuration for the API playground.",
"displayName": "value",
"permission": "SUBACCOUNT_PERMISSION_READ_SUBACCOUNT",
"policyAction": "TRADE_SPOT"
}
],
"roles": [
{
"assignable": false,
"description": "Example configuration for the API playground.",
"displayName": "value",
"permissions": [
"SUBACCOUNT_PERMISSION_READ_SUBACCOUNT"
],
"role": "VIEWER"
}
]
}Request
auth.v1.ListSubaccountRolesRequestResponse
auth.v1.ListSubaccountRolesResponse 4 fields
permission enum
Stable permission identifier used by authorization and clients.
SUBACCOUNT_PERMISSION_READ_SUBACCOUNT SUBACCOUNT_PERMISSION_UPDATE_SUBACCOUNT SUBACCOUNT_PERMISSION_READ_BALANCES SUBACCOUNT_PERMISSION_READ_SPOT SUBACCOUNT_PERMISSION_TRADE_SPOT SUBACCOUNT_PERMISSION_READ_INTERNAL_TRANSFERS SUBACCOUNT_PERMISSION_INTERNAL_TRANSFER SUBACCOUNT_PERMISSION_EXTERNAL_WITHDRAW SUBACCOUNT_PERMISSION_READ_ADDRESS_BOOK SUBACCOUNT_PERMISSION_MANAGE_ADDRESS_BOOK SUBACCOUNT_PERMISSION_READ_MEMBERS SUBACCOUNT_PERMISSION_MANAGE_MEMBERS SUBACCOUNT_PERMISSION_READ_INVITES SUBACCOUNT_PERMISSION_MANAGE_INVITES SUBACCOUNT_PERMISSION_READ_API_KEYS SUBACCOUNT_PERMISSION_MANAGE_API_KEYS SUBACCOUNT_PERMISSION_READ_SUBACCOUNT_POLICY SUBACCOUNT_PERMISSION_MANAGE_SUBACCOUNT_POLICY SUBACCOUNT_PERMISSION_READ_ACTIVITY SUBACCOUNT_PERMISSION_READ_ACTIVITY_SECURITY_DETAILS SUBACCOUNT_PERMISSION_MANAGE_MEMBER_MFA_REQUIREMENT SUBACCOUNT_PERMISSION_CREATE_DEPOSIT_ADDRESS SUBACCOUNT_PERMISSION_READ_DEPOSIT_ADDRESSES SUBACCOUNT_PERMISSION_READ_GUARD_SIGNER_STATUS SUBACCOUNT_PERMISSION_MANAGE_GUARD_SIGNER SUBACCOUNT_PERMISSION_READ_AUTO_WITHDRAW SUBACCOUNT_PERMISSION_MANAGE_AUTO_WITHDRAW SUBACCOUNT_PERMISSION_SWAP
displayName string
Human-readable permission name.
description string
Human-readable explanation of the capability and its important boundaries.
policyAction enum
Policy action that can further restrict this permission. Unspecified means the permission is controlled by role and request context only.
TRADE_SPOT INTERNAL_TRANSFER EXTERNAL_WITHDRAW READ_BALANCES READ_SPOT READ_INTERNAL_TRANSFERS READ_ADDRESS_BOOK MANAGE_ADDRESS_BOOK READ_AUTO_WITHDRAW MANAGE_AUTO_WITHDRAW SWAP
5 fields
role enum
Stable built-in role identifier.
VIEWER TRADER LEVERAGED_TRADER TREASURY ADMIN OWNER
displayName string
Human-readable role name.
description string
Human-readable summary of the role.
assignable boolean
Whether this role can be assigned to a delegated member.
permissions enum[]
Complete role-granted permission set in canonical permission order.
SUBACCOUNT_PERMISSION_READ_SUBACCOUNT SUBACCOUNT_PERMISSION_UPDATE_SUBACCOUNT SUBACCOUNT_PERMISSION_READ_BALANCES SUBACCOUNT_PERMISSION_READ_SPOT SUBACCOUNT_PERMISSION_TRADE_SPOT SUBACCOUNT_PERMISSION_READ_INTERNAL_TRANSFERS SUBACCOUNT_PERMISSION_INTERNAL_TRANSFER SUBACCOUNT_PERMISSION_EXTERNAL_WITHDRAW SUBACCOUNT_PERMISSION_READ_ADDRESS_BOOK SUBACCOUNT_PERMISSION_MANAGE_ADDRESS_BOOK SUBACCOUNT_PERMISSION_READ_MEMBERS SUBACCOUNT_PERMISSION_MANAGE_MEMBERS SUBACCOUNT_PERMISSION_READ_INVITES SUBACCOUNT_PERMISSION_MANAGE_INVITES SUBACCOUNT_PERMISSION_READ_API_KEYS SUBACCOUNT_PERMISSION_MANAGE_API_KEYS SUBACCOUNT_PERMISSION_READ_SUBACCOUNT_POLICY SUBACCOUNT_PERMISSION_MANAGE_SUBACCOUNT_POLICY SUBACCOUNT_PERMISSION_READ_ACTIVITY SUBACCOUNT_PERMISSION_READ_ACTIVITY_SECURITY_DETAILS SUBACCOUNT_PERMISSION_MANAGE_MEMBER_MFA_REQUIREMENT SUBACCOUNT_PERMISSION_CREATE_DEPOSIT_ADDRESS SUBACCOUNT_PERMISSION_READ_DEPOSIT_ADDRESSES SUBACCOUNT_PERMISSION_READ_GUARD_SIGNER_STATUS SUBACCOUNT_PERMISSION_MANAGE_GUARD_SIGNER SUBACCOUNT_PERMISSION_READ_AUTO_WITHDRAW SUBACCOUNT_PERMISSION_MANAGE_AUTO_WITHDRAW SUBACCOUNT_PERMISSION_SWAP
| 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. |