Start Email Auth
Send a one-time code to the user’s email address.| Parameter | Type | Description |
|---|---|---|
email | String | Email address that receives the one-time code. |
Void.
Complete Email Auth
Complete the flow with the code entered by the user. Automatic mode returns an active wallet when possible.| Parameter | Type | Description |
|---|---|---|
code | String | One-time code entered by the user. |
walletSelection | WalletSelectionBehavior | Defaults to .automatic. Use .manual to receive a pending wallet selection. |
walletType | WalletType | Optional wallet type. Defaults to .ethereum. |
sessionLifetimeSeconds | UInt32 | Optional requested wallet API session lifetime in seconds. Defaults to one week. |
CompleteAuthResult, either .walletSelected(...) or .walletSelection(PendingWalletSelection).
Sign In With OIDC Token
Use OIDC ID-token auth for providers such as Google Sign-In. Pass the provider token plus the issuer and audience used to mint it.startOidcRedirectAuth and handleOidcRedirectCallback for authorization-code PKCE redirect auth.
Parameters
| Parameter | Type | Description |
|---|---|---|
idToken | String | OIDC ID token from the identity provider. |
issuer | String | Expected token issuer, such as https://accounts.google.com. |
audience | String | Expected token audience. |
walletType | WalletType | Optional wallet type. Defaults to .ethereum. |
walletSelection | WalletSelectionBehavior | Defaults to .automatic. Use .manual to receive a pending wallet selection. |
sessionLifetimeSeconds | UInt32 | Optional requested wallet API session lifetime in seconds. Defaults to one week. |
CompleteAuthResult, either .walletSelected(...) or .walletSelection(PendingWalletSelection).
Start OIDC Redirect Auth
Start a Google authorization-code PKCE flow and open the returned authorization URL with a system auth browser.yourapp, in your app target before using redirect auth.
Parameters
| Parameter | Type | Description |
|---|---|---|
provider | OidcProviderConfig | Google provider configuration returned by OidcProviders.google(). |
redirectUri | String | App callback URL that receives the provider redirect. Configure this URL scheme or universal link in the app target. |
walletType | WalletType | Optional wallet type. Defaults to .ethereum. |
loginHint | String? | Optional Google login_hint. When omitted for Google, the SDK can reuse the previous session email. |
authorizeParams | [String: String] | Extra authorization query parameters passed to the provider. |
StartOidcRedirectAuthResult with the provider authorizationUrl. state and challenge are SDK-managed values.
Handle OIDC Redirect Callback
Pass incoming app-link URLs to the callback handler. It is safe to call for unrelated links.| Parameter | Type | Description |
|---|---|---|
callbackUrl | String? | Incoming app-link URL. |
walletSelection | WalletSelectionBehavior | Defaults to .automatic. Use .manual to receive a pending wallet selection. |
sessionLifetimeSeconds | UInt32 | Optional requested wallet API session lifetime in seconds. Defaults to one week. |
OidcRedirectAuthResult.
Use Wallet
Activate an existing wallet by server-side wallet ID.| Parameter | Type | Description |
|---|---|---|
walletId | String | Wallet ID returned by auth completion or listWallets(). |
WalletActivationResult.
Create Wallet
Create and activate a new wallet for the authenticated user.| Parameter | Type | Description |
|---|---|---|
walletType | WalletType | Wallet type to create. Defaults to .ethereum. |
reference | String? | Optional app-defined wallet reference. |
WalletActivationResult.