signUpWithOauth()

Overview

Signs up a user using OAuth authentication.

• This function creates a new sub-organization for the user using the provided OIDC token, public key, and provider name.
• Handles the full OAuth sign-up flow, including sub-organization creation and session management.
• Optionally accepts additional sub-organization creation parameters and a custom session key.
• After successful sign-up, automatically logs in the user and returns a signed JWT session token.

Package: core

Defined in: clients/core.ts:1727

Parameters

params · SignUpWithOauthParams · required

Show params details

params.createSubOrgParams

CreateSubOrgParams

parameters for sub-organization creation (e.g., authenticators, user metadata).

Show createSubOrgParams details

params.createSubOrgParams.apiKeys

object[]

list of api keys

params.createSubOrgParams.authenticators

object[]

list of authenticators

params.createSubOrgParams.customWallet

CustomWallet

custom wallets to create during sub-org creation time

Show customWallet details

params.createSubOrgParams.customWallet.walletAccounts

v1WalletAccountParams[]

required

list of wallet accounts to create

params.createSubOrgParams.customWallet.walletName

string

required

name of the wallet created

params.createSubOrgParams.oauthProviders

Provider[]

list of oauth providers

params.createSubOrgParams.subOrgName

string

name of the sub-organization

params.createSubOrgParams.userEmail

string

email of the user

params.createSubOrgParams.userName

string

name of the user

params.createSubOrgParams.userPhoneNumber

string

phone number of the user

params.createSubOrgParams.userTag

string

tag of the user

params.createSubOrgParams.verificationToken

string

verification token if email or phone number is provided

params.oidcToken

string

required

OIDC token received after successful authentication with the OAuth provider.

params.providerName

string

required

name of the OAuth provider (e.g., “Google”, “Apple”).

params.publicKey

string

required

public key to associate with the new sub-organization.

params.sessionKey

string

session key to use for session creation (defaults to the default session key).

Response

A successful response returns the following fields:

returns · BaseAuthResult · required

A promise that resolves to a BaseAuthResult, which includes:

• sessionToken: the signed JWT session token.