# 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](/authentication/overview).

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

## Related

- [API reference](/http-api/reference): every tag
- [Auth guide](/authentication/overview)
