Reference
Auth

Auth

Methods of @cobuntu/embed for member sign-in, sign-up, sign-in links, password recovery and Continue with Google. Setup, sessions and errors are on the client overview; each method links to its endpoint in the REST API reference.

auth

Needs a secret key with MEMBER_AUTH.

auth.signIn

signIn({ email, password, referralCode? })

Route: POST /auth/sign-in
Returns: { token, user, newMember }
Codes: INVALID_CREDENTIALS, SUSPENDED, APPLICATION_PENDING, NOT_MEMBER

auth.signUp

signUp({ name, email, password, marketingOptIn?, referralCode? })

Route: POST /auth/sign-up
Returns: { token, user, newMember: true }
Codes: WEAK_PASSWORD, EMAIL_TAKEN, APPLICATION_REQUIRED

auth.emailLink

emailLink({ email, redirectPath? })

Route: POST /auth/email-link
Returns: { ok: true }, always

auth.verifyEmailLink

verifyEmailLink(token)

Route: POST /auth/email-link/verify
Returns: { token, user, newMember }
Codes: LINK_EXPIRED, INVALID_LINK

auth.me

me()

Route: GET /auth/me
Returns: { user, member, segments }
Codes: INVALID_SESSION

auth.passwordReset

passwordReset(email)

Route: POST /auth/password-reset
Returns: { ok: true }, always

auth.validatePasswordReset

validatePasswordReset(token)

Route: GET /auth/password-reset/validate
Returns: { valid: true }
Codes: LINK_EXPIRED, INVALID_LINK

auth.confirmPasswordReset

confirmPasswordReset({ token, password })

Route: POST /auth/password-reset/confirm
Returns: { token, user, newMember }
Codes: WEAK_PASSWORD, LINK_EXPIRED, INVALID_LINK

auth.verifyEmail

verifyEmail(token)

Route: POST /auth/verify-email
Returns: { verified: true }
Codes: LINK_EXPIRED, INVALID_LINK, EMAIL_TAKEN

auth.googleStartUrl

googleStartUrl({ returnUrl, codeChallenge, state? })

Route: none (builds a URL)
Returns: string

auth.exchangeOAuthCode

exchangeOAuthCode({ code, codeVerifier })

Route: POST /auth/oauth/exchange
Returns: { token, user, newMember: false, isSignUp }
Codes: INVALID_CODE, SUSPENDED