Skip to content
BuildBase
HTTP API menu

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.

MethodPathWhat it does
POST/api/v1/auth/age-gateAnswer the age question on hosted sign-up or at sign-in
POST/api/v1/auth/agent/registerRegister a pre-verified agent user account
GET/api/v1/auth/captcha/challengeGet a proof-of-work challenge for the hosted sign-up page
GET/api/v1/auth/configGet the hosted sign-in page configuration for an organization
GET/api/v1/auth/consentCheck whether the signed-in person must consent to an agent client
POST/api/v1/auth/consent/approveApprove an agent client's requested scopes
POST/api/v1/auth/consent/denyDeny an agent client's consent request
POST/api/v1/auth/consent/listList the agents a user has connected, for the app's backend
POST/api/v1/auth/consent/revokeRevoke a user's grant to an OAuth client
POST/api/v1/auth/device/decideApprove or deny a device authorization request
POST/api/v1/auth/device/lookupLook 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/discoverStart enterprise SSO discovery for an email address
GET/api/v1/auth/enterprise/{orgId}/callbackFinish an enterprise SSO sign-in returning from WorkOS
GET/api/v1/auth/enterprise/{orgId}/sign-inStart 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}/chooseContinue an enterprise SSO sign-in with the connection the person chose
POST/api/v1/auth/guestCreate a guest account and sign it in
POST/api/v1/auth/impersonation/redeemRedeem a one-time impersonation ticket for the app's callback URL
POST/api/v1/auth/loginSign in with a password
POST/api/v1/auth/login-handoffExchange a single-use login handoff code for the login token
POST/api/v1/auth/magic-linkSend a magic sign-in link to an email address
POST/api/v1/auth/magic-link/checkCheck whether a magic link can be used in this browser
POST/api/v1/auth/magic-link/verifyVerify a magic link and sign the person in
POST/api/v1/auth/mfa/sms/sendSend a text-message code for the second step of a pending sign-in
POST/api/v1/auth/mfa/totp/enrollStart setting up an authenticator app during a sign-in that requires it
POST/api/v1/auth/mfa/totp/enroll/confirmConfirm a new authenticator app and finish the pending sign-in
POST/api/v1/auth/mfa/verifyVerify 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}/deleteDelete a saved monday.com credential
POST/api/v1/auth/otp/sendSend a one-time email code for sign-in or sign-up
POST/api/v1/auth/otp/verifyVerify a one-time email code and sign the person in
GET/api/v1/auth/passkey/listList the signed-in user's passkeys
POST/api/v1/auth/passkey/login/optionsStart a passkey sign-in
POST/api/v1/auth/passkey/login/verifyVerify a passkey assertion and sign the person in
POST/api/v1/auth/passkey/register/optionsStart registering a passkey for the signed-in user
POST/api/v1/auth/passkey/register/verifyVerify 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/registerCreate an account for a verified phone number and sign in
POST/api/v1/auth/phone/sendSend a one-time code to a phone number
POST/api/v1/auth/phone/verifyVerify a phone code and sign the person in
POST/api/v1/auth/redirectFinish hosted sign-in and get the app's callback URL
POST/api/v1/auth/registerRegister a new account on hosted sign-up
POST/api/v1/auth/requestStart a hosted sign-in and get the sign-in page URL
POST/api/v1/auth/reset-passwordReset a password with an emailed code
POST/api/v1/auth/send-forgot-password-verification-codeSend a password reset code by email
POST/api/v1/auth/social/google/{orgId}/{methodId}/one-tapSign in with a Google One Tap credential
GET/api/v1/auth/social/google/{orgId}/{methodId}/one-tap/nonceGet a single-use nonce for Google One Tap
GET/api/v1/auth/social/{slug}/shared/callbackFinish 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}/callbackFinish a social sign-in returning from the provider
POST/api/v1/auth/social/{slug}/{orgId}/{methodId}/callbackFinish a social sign-in returned by form post from the provider
GET/api/v1/auth/supported-methodsList the sign-in methods offered on a hosted sign-in screen
POST/api/v1/auth/tokenExchange an authorization code for a session and user profile
GET/api/v1/auth/trackingGet the tracking settings for the current hosted sign-in
GET/api/v1/auth/users/profileGet the profile of the user the login token belongs to
POST/api/v1/auth/users/send-email-verification-codeSend an email verification code to the signed-in user
POST/api/v1/auth/users/verify-emailVerify the signed-in user's email with a code
POST/api/v1/auth/wallet/nonceGet a nonce for a wallet sign-in message
POST/api/v1/auth/wallet/registerCreate an account for a verified wallet and sign in
POST/api/v1/auth/wallet/verifyVerify a signed wallet message and sign the person in