ユーザー API キーの作成と管理 - Node.js SDK
Atlas Device SDK は非推奨です。 詳細については、 の廃止ページを参照してください。
ユーザー API キーの作成
新しいユーザー API キーを作成するには、ユーザーのすべての API キー間で一意の名前をApiKeyAuth.create() に渡します。
const user = app.currentUser; const key = await user.apiKeys.create("apiKeyName");
警告
API キー値の保存
SDK は、作成時にのみユーザー API キーの値を返します。 keyの値を安全に保存し、この値を使用してログインできるようにします。
keyの値を失うか保存しない場合、回復する方法はありません。 新しいユーザー API キーを作成する必要があります。
ユーザー API キーの検索
ユーザーのすべての API キーをリストする配列を取得するには、 ApiKeyAuth.fetchAll() を呼び出します。
特定の API キーを検索するには、キーの_idをApiKeyAuth.fetch() に渡します。
const user = app.currentUser; // List all of a user's keys const keys = await user.apiKeys.fetchAll(); // Get a specific key by its ID const key = await user.apiKeys.fetch("5eb5931548d79bc784adf46e");
API キーの有効化または無効化
ユーザー API キーを有効または無効にするには、キーの_idをApiKeyAuth.enable()またはApiKeyAuth.disable()に渡します。 キーが無効になっている場合、ユーザーに代わってログインするために使用することはできません。
// Get the ID of a User API Key const user = app.currentUser; const apiKeys = await user.apiKeys.fetchAll(); const keyId = apiKeys[0]["_id"]; // Enable the User API Key await user.apiKey.enable(keyId); // Disable the User API Key await user.apiKey.disable(keyId);
API キーを削除する
ユーザー API を永続的に削除するには、キーの_idをApiKeyAuth.delete()に渡します。 削除されたキーは復元できません。
// Get the ID of a User API Key const user = app.currentUser; const apiKeys = await user.apiKeys.fetchAll(); const keyId = apiKeys[0]["_id"]; // Delete the User API Key await user.apiKey.delete(keyId);