API reference

/v1/account

28 operations

← All groups

MethodPathSummaryAuth
GET/v1/account/api-keysList API keys owned by the current tenant userSession
POST/v1/account/api-keysCreate and activate an API key for the current tenant userSession
GET/v1/account/api-keys/{key_id}Get API key metadata owned by the current tenant userSession
PATCH/v1/account/api-keys/{key_id}Update API key metadataSession
POST/v1/account/api-keys/{key_id}/activateActivate a pending API key and issue its secretSession
POST/v1/account/api-keys/{key_id}/revokeRevoke an API keySession
POST/v1/account/api-keys/{key_id}/rotateRotate an active API key secretSession
GET/v1/account/balanceRead the active tenant CNY balanceSession
GET/v1/account/ledgerList immutable entries for the active tenant CNY balanceSession
GET/v1/account/messagesList the current user's in-app messagesSession
POST/v1/account/messages/{event_id}/deliveredMark an in-app message deliveredSession
POST/v1/account/messages/{event_id}/readMark an in-app message readSession
GET/v1/account/mfaRead the authenticated account's current MFA stateSession
POST/v1/account/mfa/disableDisable active MFA after strong reauthenticationSession
POST/v1/account/mfa/enrollmentsBegin TOTP enrollmentSession
POST/v1/account/mfa/enrollments/{credential_id}/activateActivate a pending TOTP credentialSession
POST/v1/account/mfa/resetReset active MFA after strong reauthenticationSession
POST/v1/account/mfa/step-up-proofsCreate a short-lived bound step-up proofSession
GET/v1/account/notification-subscriptions/{event_type}Read the current user's event subscriptionSession
PUT/v1/account/notification-subscriptions/{event_type}Update the current user's event subscriptionSession
GET/v1/account/order-usersSearch active users for order entrySession
GET/v1/account/ordersList tenant consumption recordsSession
POST/v1/account/ordersEnter an audited compatibility order recordSession
PATCH/v1/account/orders/{id}Edit an audited compatibility order recordSession
DELETE/v1/account/orders/{id}Archive an audited compatibility order recordSession
POST/v1/account/passwordRe-authenticate and change the current tenant user's passwordSession
GET/v1/account/profileGet the current tenant user's profileSession
PATCH/v1/account/profileUpdate the current tenant user's profileSession

Contract file:api/openapi/v1/control.yaml api/control-announcements.openapi.yaml api/control-mfa.openapi.yaml api/control-notifications.openapi.yaml api/control-account-orders.openapi.yaml