ユーザー API キーの管理 - .NET SDK

項目一覧

ユーザー API キーの作成

ユーザー API キーの検索
API キーの有効化または無効化
API キーを削除する

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

アプリケーションユーザーは、.NET SDK を使用してユーザー API キーを生成できます。各デバイスまたはサービスに一意のユーザー API キーを関連付けるため、デバイスやサービスがユーザーに代わって Atlas App Services と通信できるようにできます。

ユーザー API キーは、常に別の非匿名認証プロバイダーによって作成されたユーザーオブジェクトに常に関連付けられます。各ユーザーは、最大 20 個のユーザーキーを自身のアカウントに関連付けることができます。

注意

ユーザー 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 のクエリ

ユーザーの管理