auth.v1.SubaccountRoleService

GetEffectiveSubaccountPermissions

Return the authenticated caller's effective permissions for one sub-account.

Method

POST

Path

auth.v1.SubaccountRoleService/GetEffectiveSubaccountPermissions

Service

auth.v1.SubaccountRoleService

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

POST

auth.v1.SubaccountRoleService/GetEffectiveSubaccountPermissions

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/auth.v1.SubaccountRoleService/GetEffectiveSubaccountPermissions' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "subaccountId": "6789012345678"
}'

Responses

{
  "permissions": [
    "SUBACCOUNT_PERMISSION_READ_SUBACCOUNT"
  ],
  "role": "VIEWER",
  "subaccountPolicyId": "1"
}

Request

auth.v1.GetEffectiveSubaccountPermissionsRequest

Response

auth.v1.GetEffectiveSubaccountPermissionsResponse

subaccountId string (fixed64) > 0

Target sub-account (opaque ID).

role enum must be defined value

Current role of the caller on the sub-account.

VIEWER TRADER LEVERAGED_TRADER TREASURY ADMIN OWNER

permissions enum[] max 64 items, unique

Permissions allowed by the role and current sub-account policy. Resource state, MFA, limits, and other request context may still deny an operation.

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

subaccountPolicyId string (fixed64)

Attached sub-account policy identifier, or zero when no policy is attached.

Possible errors: 5

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.