Auth API
The Auth operations of the BuildBase HTTP API: method, path, sign-in, request fields, answers and errors for each.
63 operations, 45 fully described. For how this part of BuildBase works, start with the guide.
| Method | Path | What it does |
|---|---|---|
| POST | /api/v1/auth/age-gate | Answer the age question on hosted sign-up or at sign-in |
| POST | /api/v1/auth/agent/register | Register a pre-verified agent user account |
| GET | /api/v1/auth/captcha/challenge | Get a proof-of-work challenge for the hosted sign-up page |
| GET | /api/v1/auth/config | Get the hosted sign-in page configuration for an organization |
| GET | /api/v1/auth/consent | Check whether the signed-in person must consent to an agent client |
| POST | /api/v1/auth/consent/approve | Approve an agent client's requested scopes |
| POST | /api/v1/auth/consent/deny | Deny an agent client's consent request |
| POST | /api/v1/auth/consent/list | List the agents a user has connected, for the app's backend |
| POST | /api/v1/auth/consent/revoke | Revoke a user's grant to an OAuth client |
| POST | /api/v1/auth/device/decide | Approve or deny a device authorization request |
| POST | /api/v1/auth/device/lookup | Look up the code a device shows and start a sign-in for it |
| GET | /api/v1/auth/enterprise/choices/{choice} | Get the SSO connections offered for a pending enterprise sign-in choice |
| POST | /api/v1/auth/enterprise/discover | Start enterprise SSO discovery for an email address |
| GET | /api/v1/auth/enterprise/{orgId}/callback | Finish an enterprise SSO sign-in returning from WorkOS |
| GET | /api/v1/auth/enterprise/{orgId}/sign-in | Start an identity-provider-initiated enterprise SSO sign-in |
| GET | /api/v1/auth/enterprise/{orgId}/start/{methodId} | Start an enterprise SSO sign-in for a discovered email address |
| GET | /api/v1/auth/enterprise/{orgId}/start/{methodId}/choose | Continue an enterprise SSO sign-in with the connection the person chose |
| POST | /api/v1/auth/guest | Create a guest account and sign it in |
| POST | /api/v1/auth/impersonation/redeem | Redeem a one-time impersonation ticket for the app's callback URL |
| POST | /api/v1/auth/login | Sign in with a password |
| POST | /api/v1/auth/login-handoff | Exchange a single-use login handoff code for the login token |
| POST | /api/v1/auth/magic-link | Send a magic sign-in link to an email address |
| POST | /api/v1/auth/magic-link/check | Check whether a magic link can be used in this browser |
| POST | /api/v1/auth/magic-link/verify | Verify a magic link and sign the person in |
| POST | /api/v1/auth/mfa/sms/send | Send a text-message code for the second step of a pending sign-in |
| POST | /api/v1/auth/mfa/totp/enroll | Start setting up an authenticator app during a sign-in that requires it |
| POST | /api/v1/auth/mfa/totp/enroll/confirm | Confirm a new authenticator app and finish the pending sign-in |
| POST | /api/v1/auth/mfa/verify | Verify a second-step code and finish the pending sign-in |
| GET | /api/v1/auth/monday.com/authorize/{orgId} | Start or resume the monday.com app authorization hand-off |
| GET | /api/v1/auth/monday.com/callback/{orgId} | Handle the monday.com OAuth callback |
| POST | /api/v1/auth/monday.com/credentials/{orgId} | List the saved monday.com credential for the calling monday user |
| POST | /api/v1/auth/monday.com/credentials/{orgId}/delete | Delete a saved monday.com credential |
| POST | /api/v1/auth/otp/send | Send a one-time email code for sign-in or sign-up |
| POST | /api/v1/auth/otp/verify | Verify a one-time email code and sign the person in |
| GET | /api/v1/auth/passkey/list | List the signed-in user's passkeys |
| POST | /api/v1/auth/passkey/login/options | Start a passkey sign-in |
| POST | /api/v1/auth/passkey/login/verify | Verify a passkey assertion and sign the person in |
| POST | /api/v1/auth/passkey/register/options | Start registering a passkey for the signed-in user |
| POST | /api/v1/auth/passkey/register/verify | Verify a new passkey and save it to the signed-in user's account |
| DELETE | /api/v1/auth/passkey/{id} | Remove one of the signed-in user's passkeys |
| POST | /api/v1/auth/phone/register | Create an account for a verified phone number and sign in |
| POST | /api/v1/auth/phone/send | Send a one-time code to a phone number |
| POST | /api/v1/auth/phone/verify | Verify a phone code and sign the person in |
| POST | /api/v1/auth/redirect | Finish hosted sign-in and get the app's callback URL |
| POST | /api/v1/auth/register | Register a new account on hosted sign-up |
| POST | /api/v1/auth/request | Start a hosted sign-in and get the sign-in page URL |
| POST | /api/v1/auth/reset-password | Reset a password with an emailed code |
| POST | /api/v1/auth/send-forgot-password-verification-code | Send a password reset code by email |
| POST | /api/v1/auth/social/google/{orgId}/{methodId}/one-tap | Sign in with a Google One Tap credential |
| GET | /api/v1/auth/social/google/{orgId}/{methodId}/one-tap/nonce | Get a single-use nonce for Google One Tap |
| GET | /api/v1/auth/social/{slug}/shared/callback | Finish a social sign-in that used the shared development provider app |
| GET | /api/v1/auth/social/{slug}/{orgId}/{methodId} | Start a social sign-in by redirecting to the provider |
| GET | /api/v1/auth/social/{slug}/{orgId}/{methodId}/callback | Finish a social sign-in returning from the provider |
| POST | /api/v1/auth/social/{slug}/{orgId}/{methodId}/callback | Finish a social sign-in returned by form post from the provider |
| GET | /api/v1/auth/supported-methods | List the sign-in methods offered on a hosted sign-in screen |
| POST | /api/v1/auth/token | Exchange an authorization code for a session and user profile |
| GET | /api/v1/auth/tracking | Get the tracking settings for the current hosted sign-in |
| GET | /api/v1/auth/users/profile | Get the profile of the user the login token belongs to |
| POST | /api/v1/auth/users/send-email-verification-code | Send an email verification code to the signed-in user |
| POST | /api/v1/auth/users/verify-email | Verify the signed-in user's email with a code |
| POST | /api/v1/auth/wallet/nonce | Get a nonce for a wallet sign-in message |
| POST | /api/v1/auth/wallet/register | Create an account for a verified wallet and sign in |
| POST | /api/v1/auth/wallet/verify | Verify a signed wallet message and sign the person in |
Related
- API reference: every tag
- Auth guide