Skip to content

@collectivtech/alana-sdk-js


@collectivtech/alana-sdk-js / resources/authentication / TokenResponse

Interface: TokenResponse ​

Defined in: src/resources/authentication.ts:8

An API login response containing JWT tokens.

Properties ​

access_token ​

access_token: string

Defined in: src/resources/authentication.ts:12

The access token, used for general API authorization.


id_token? ​

optional id_token?: string

Defined in: src/resources/authentication.ts:17

The ID token, used for certain identity-related API flows.


refresh_token? ​

optional refresh_token?: string

Defined in: src/resources/authentication.ts:26

The refresh token, passed to the Token Refresh API to get a new set of tokens when the access or ID token has expired.

The refresh token is long-lived, to prevent the need for users to log in multiple times in quick succession.

ALANA™, ALANA Platform™, ALANA Guide™, and ALANA Partner™ are trademarks of Collectiv Technologies Inc.