Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

@smokeballdev/smokeball-client-sdk

ā€‹
Interface: Api

Entry point for auth to Smokeball.

ā€‹
Methods

ā€‹
connect()

connect(request): Promise<TokenSession>
Establishes a new token session that can be used to generate fresh OAuth tokens.

ā€‹
Parameters

request
ConnectRequest

ā€‹
Returns

Promise<TokenSession> a token session.

ā€‹
Example

const request: ConnectRequest = {
 jwt
};
const session = await sdk.auth.connect(request);
const token = await session.accessToken();

ā€‹
idToken()

idToken(): Promise<string>

ā€‹
Returns

Promise<string> the current id token.

ā€‹
Deprecated

Use connect() instead. Retrieves the id token. This token can be used to access the api. Only available to trusted clients.

ā€‹
Example

const token = await sdk.auth.idToken();

ā€‹
token()

token(): Promise<string>

ā€‹
Returns

Promise<string> the current access token.

ā€‹
Deprecated

Use connect() instead. Retrieves the access token. Only available to trusted clients.

ā€‹
Example

const token = await sdk.auth.token();