Getting Started Create a Realm and Set Up the Basics Architecture Configuration Deployment

Passkey Authentication Email Code (OTP) Login Apple native login (in an iOS app)LDAP Corporate Directory Login

Billing Architecture Stripe Integration Creem Integration WeChat Pay Integration App Store / Google Play (IAP) Integration Wallet Payments (Google Pay / Apple Pay)Multi-Currency Pricing Invoice Management Credit Notes

Points Accounts (Credit Accounts)Points Consumption Points Quotas (Rolling Windows)Paywall configuration (payment-granted roles)

Integrating a Third-Party Backend with Herald Custom User UI MCP Integration for AI Agents OpenID Connect Integration

White-label (Realm Branding)Custom Domain

Confirm email change with verification code GET Request to change the email address for the authenticated user POST Get registration configuration status for a realm POST Public visibility of the self-service entry. Fail-closed: a missing toggle row resolves to `enabled: false`. GET Get Turnstile configuration status for a Client App GET Handle_passkey_2fa_options POST Handle_passkey_2fa_verify POST Handle_passkey_options POST Handle_passkey_verify POST Verify TOTP code for two-factor authentication POST Enterprise (LDAP) directory login. POST Public LDAP enablement flag for a Realm (login-page entry visibility). Fail-closed: absent/malformed/disabled/insecure-channel config → false. GET Authenticate user with email/username and password POST Logout POST Refresh POST Register new user account POST Confirm password reset with verification code POST Request password reset POST Email the 6-digit verification code the signup flow will later consume. POST Send an email OTP login code. POST Provision a new realm from an unauthenticated visitor and issue an immediate first-party admin-console session for the new realm admin. POST Public passkey enablement flag for a Realm. GET Switch_client POST Confirm email verification with code GET Trigger email verification POST Verify an email OTP login code and issue a session. POST

OpenapiAuth

Logout

POST

/api/auth/logout

Authorization

bearer_auth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/logout"

{  "message": "string"}

Empty

© 2026 Herald · Apache 2.0

GitHub Blog Contact Privacy Terms