Turnkey

Class: Turnkey

Defined in: sdk-browser/src/sdk-client.ts:64

Constructors

Constructor

new Turnkey(config): TurnkeyBrowserSDK

Defined in: sdk-browser/src/sdk-client.ts:69

Parameters

config

TurnkeySDKBrowserConfig

Returns

TurnkeyBrowserSDK

Properties

config

config: TurnkeySDKBrowserConfig

Defined in: sdk-browser/src/sdk-client.ts:65

---

stamper

protected stamper: undefined | Stamper

Defined in: sdk-browser/src/sdk-client.ts:67

Methods

currentUserSession()

currentUserSession(): Promise<undefined | TurnkeyBrowserClient>

Defined in: sdk-browser/src/sdk-client.ts:190

If there is a valid, current user session, this will return a read-enabled TurnkeyBrowserClient that can make read requests to Turnkey without additional authentication. This is powered by a session header resulting from a prior successful login call.

Returns

Promise<undefined | TurnkeyBrowserClient>

---

getCurrentSubOrganization()

getCurrentSubOrganization(): Promise<undefined | SubOrganization>

Defined in: sdk-browser/src/sdk-client.ts:256

Fetches the current user’s organization details.

Returns

Promise<undefined | SubOrganization>

---

getCurrentUser()

getCurrentUser(): Promise<undefined | User>

Defined in: sdk-browser/src/sdk-client.ts:268

Fetches the currently active user.

Returns

Promise<undefined | User>

---

getReadWriteSession()

getReadWriteSession(): Promise<undefined | ReadWriteSession>

Defined in: sdk-browser/src/sdk-client.ts:216

If there is a valid, current read-session, this will return an auth bundle and its expiration. This auth bundle can be used in conjunction with an iframeStamper to create a read + write session.

Returns

Promise<undefined | ReadWriteSession>

Deprecated

use getSession instead

---

getSession()

getSession(): Promise<undefined | Session>

Defined in: sdk-browser/src/sdk-client.ts:236

If there is a valid, active READ_WRITE session, this will return it

Returns

Promise<undefined | Session>

---

iframeClient()

iframeClient(params): Promise<TurnkeyIframeClient>

Defined in: sdk-browser/src/sdk-client.ts:106

Parameters

params

IframeClientParams

Returns

Promise<TurnkeyIframeClient>

---

logout()

logout(): Promise<boolean>

Defined in: sdk-browser/src/sdk-client.ts:306

Clears out all data pertaining to an end user session.

Returns

Promise<boolean>

---

passkeyClient()

passkeyClient(params?): TurnkeyPasskeyClient

Defined in: sdk-browser/src/sdk-client.ts:78

Creates a passkey client. The parameters override the default values passed to the underlying Turnkey WebauthnStamper

Parameters

params?

PasskeyClientParams

Returns

TurnkeyPasskeyClient

new TurnkeyPasskeyClient

---

serverSign()

serverSign<TResponseType>(methodName, params, serverSignUrl?): Promise<TResponseType>

Defined in: sdk-browser/src/sdk-client.ts:144

Type Parameters

TResponseType

TResponseType

Parameters

methodName

string

params

any[]

serverSignUrl?

string

Returns

Promise<TResponseType>

---

walletClient()

walletClient(wallet): TurnkeyWalletClient

Defined in: sdk-browser/src/sdk-client.ts:135

Parameters

wallet

WalletInterface

Returns

TurnkeyWalletClient