signUpWithOauth()

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: core.ts:1703

params

object

required

Show params details

params.createSubOrgParams

CreateSubOrgParams

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

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).

A successful response returns the following fields:

returns

BaseAuthResult

required

A promise that resolves to a BaseAuthResult, which includes: