SubaccountService

Set Subaccount Member MFA Requirement

Enable or disable the owner-controlled MFA requirement for protected delegated-member actions.

Method

PATCH

Path

/v1/auth/subaccounts/{subaccount_id}/member-mfa

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Conditionally required

PATCH

/v1/auth/subaccounts/{subaccount_id}/member-mfa

Request

Testnet

curl --request PATCH \ \
  --url 'https://api.testnet.polyester.com/v1/auth/subaccounts/45LUmqjT/member-mfa' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE' \
  --header 'Content-Type: application/json' \
  --data '{
  "requireMemberMfa": false
}'

Responses

{}

subaccount_id string (int64) required > 0

Sub-account whose delegated-member MFA requirement should be updated (opaque ID).

requireMemberMfa boolean

When true, delegated interactive members must satisfy MFA requirements for protected sub-account actions. This does not apply to read-only real-time subscriptions.

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.