account

API policy updates

Authenticated API policy configuration updates for one root account.

Transport

WebSocket

Encoding

Protobuf

Visibility

Authentication required

Channel

private:auth:api-policies:{rootAccountPublicId}:proto

Subscribe frame

{
  "type": "subscribe",
  "channel": "private:auth:api-policies:3gDmDv6tjHJ:proto"
}

Channel parameters

rootAccountPublicId string

Public root account identifier authorized by the subscription token.

e.g. 3gDmDv6tjHJ

Message

Payload auth.v1.ApiPolicyView

id string (fixed64)

Policy identifier (opaque ID).

Example 4611686018427387905

name string

Human-readable policy name.

Example Read and trade

description string

Optional policy description for dashboards and audits.

1 field

actions enum[] max 64 items, unique

High-level actions enabled for this API key. Up to 64 unique explicit actions may be returned.

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

spotMarketScope enum must be defined value

Market-level scope for spot markets. When ALL, spot_markets is returned for display only and is not enforced.

ALL ALLOWLIST

isTemplate boolean

When true, this policy is intended to be reused as a template across multiple API keys. When false, it represents a single-key instance.

sourceTemplateId string (fixed64)

Optional source template this policy was copied from (opaque ID). This is audit metadata only and does not imply live linkage.

createdAt string (date-time)

Creation time in UTC.

updatedAt string (date-time)

Last update time in UTC.

revision string (uint64)

Monotonic resource revision used for conditional updates.