TokenServiceは、セッショントークンとリフレッシュトークンを直接操作するための低レベルAPIを提供します。セッショントークンはCookie、リフレッシュトークンはlocalStorageという、それぞれのブラウザストレージの場所からこれらのトークンを保存・取得するロジックを処理します。
このサービスは特定のユースケースで利用できますが、ほとんどの開発者は直接使用する必要はありません。AuthServiceやcreateAxios/createFetchヘルパーのような、より高レベルの抽象化がトークンハンドリングを自動的に管理します。一般的な認証とセッション管理については、認証ガイドを参照してください。
メソッド
getSessionToken
現在のセッショントークンを取得します。サービスはまずブラウザのCookieからトークンの取得を試みます。フォールバックとして、設定で特定のキーが指定されている場合はlocalStorageを確認できます。
パラメーター
- config
object— オプションの設定オブジェクト。- sessionTokenKey
string— Cookieにセッショントークンがない場合に、window.localStorage内でセッショントークンを検索するために使用されるキー。
- sessionTokenKey
戻り値
- ****
string— セッショントークン。見つからない場合は空文字列。
例
// 主にCookieをチェックします
const sessionToken = sdk.token.getSessionToken();
// Cookieをチェックし、次に特定のキーでlocalStorageをチェックします
const sessionTokenWithFallback = sdk.token.getSessionToken({
sessionTokenKey: 'my-app-session-key',
});setSessionToken
ブラウザのCookieにセッショントークンを設定または更新します。
パラメーター
- value
string(required) — 保存するセッショントークンの値。
戻り値
- ****
void— このメソッドは値を返しません。
例
sdk.token.setSessionToken('new-session-token-value-from-server');removeSessionToken
ブラウザのCookieからセッショントークンを削除します。
戻り値
- ****
void— このメソッドは値を返しません。
例
sdk.token.removeSessionToken();getRefreshToken
ブラウザのlocalStorageからリフレッシュトークンを取得します。
戻り値
- ****
string | null— リフレッシュトークン。存在しない場合はnull。
例
const refreshToken = sdk.token.getRefreshToken();
if (refreshToken) {
console.log('Refresh token is available.');
}setRefreshToken
ブラウザのlocalStorageにリフレッシュトークンを設定または更新します。
パラメーター
- value
string(required) — 保存するリフレッシュトークンの値。
戻り値
- ****
void— このメソッドは値を返しません。
例
sdk.token.setRefreshToken('new-refresh-token-value-from-server');removeRefreshToken
ブラウザのlocalStorageからリフレッシュトークンを削除します。
戻り値
- ****
void— このメソッドは値を返しません。
例
sdk.token.removeRefreshToken();