Docs 菜单
Docs 主页
/ /
Atlas Device SDKs
/ /

创建和管理用户 API 密钥 - Node.js SDK

在此页面上

  • 创建用户 API 密钥。
  • 查找用户 API 密钥
  • 启用或禁用 API 密钥
  • 删除 API 密钥。

要创建新的用户 API 密钥,请将在所有用户 API 密钥中唯一的名称传递给ApiKeyAuth.create()。

const user = app.currentUser;
const key = await user.apiKeys.create("apiKeyName");

重要

警告

存储 API 密钥值

SDK 仅在您创建用户 API 密钥时返回该密钥的值。 请确保安全存储 key值,以便使用它登录。

如果丢失或未存储key值,则无法恢复。 您需要创建新的用户 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 密钥,请将密钥的_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,请将密钥的_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);

后退

关联用户身份

来年

同步数据