管理用户 API 密钥 — .NET SDK

在此页面上

创建用户 API 密钥。

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

Atlas Device SDK 已弃用。有关详细信息，请参阅弃用页面。

应用程序用户可以使用 .NET SDK 生成用户 API 密钥。您可以将唯一的用户 API 密钥与每台设备或服务相关联，从而允许设备或服务代表用户与 Atlas App Services 通信。

用户 API 密钥始终与其他非匿名身份验证提供商创建的用户对象相关联。每个用户最多可以将 20 个用户密钥与其帐户关联。

注意

用户API密钥与服务器API密钥不同，服务器 API 密钥允许用户或服务使用API密钥身份验证提供者程序直接向App Services进行身份验证。要学习；了解有关服务器API密钥的更多信息，请参阅 API密钥身份验证。

创建用户 API 密钥。

警告

存储 API 密钥值

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

如果丢失或未存储key值，则无法恢复。您需要创建新的用户 API 密钥。

var newKey = await user.ApiKeys.CreateAsync("someKeyName");
Console.WriteLine($"I created a key named {newKey.Name}. " +
    $"Is it enabled? {newKey.IsEnabled}");

查找用户 API 密钥

要获取单个密钥，请执行以下操作：

var key = await user.ApiKeys.FetchAsync(ObjectId.Parse("00112233445566778899aabb"));
Console.WriteLine($"I fetched the key named {key.Name}. " +
    $"Is it enabled? {key.IsEnabled}");

要获取所有密钥：

var allKeys = await user.ApiKeys.FetchAllAsync();
foreach (var key in allKeys)
{
    Console.WriteLine($"I fetched the key named {key.Name}. " +
        $"Is it enabled? {key.IsEnabled}");
}

启用或禁用 API 密钥

var key = await user.ApiKeys.FetchAsync(ObjectId.Parse("00112233445566778899aabb"));
if (!key.IsEnabled)
{
    // enable the key
    await user.ApiKeys.EnableAsync(key.Id);
}
else
{
    // disable the key
    await user.ApiKeys.DisableAsync(key.Id);
}

删除 API 密钥。

await user.ApiKeys.DeleteAsync(ObjectId.Parse("00112233445566778899aabb"));

后退

查询 MongoDB

来年

管理用户