API キー認証

Overview

API キー認証プロバイダを使用すると、ユーザーは生成されたキーを使用してログインできます。

App Services では、次の 2 種類の API キーがサポートされています。

• サーバー API キー: App Services CLI、API、または UI から作成される、サーバー ユーザーに関連付けられたAPIキー。

• ユーザー API キー: アプリケーション ユーザーに関連付けられている Realm SDK から作成された API キー。

API キーは自動的に期限切れになりません。

API キー認証の有効化

API キー ユーザーを使用するには、まず API キー認証プロバイダを有効にする必要があります。API キー認証プロバイダには、設定オプションはありません。

{
  "api-key": {
    "name": "api-key",
    "type": "api-key",
    "disabled": false
  }
}

API キー ユーザー オブジェクト

すべての App Services ユーザーには一意のメタデータ オブジェクトがあります。オブジェクトは、ユーザーによって呼び出される関数と、ユーザーが行ったリクエストのルール式に渡されます。API キー ユーザー オブジェクトでは、type フィールドの値は "server" です。例:

{
  id: "<Unique User ID>",
  type: "server",
  data: <user data object>,
  custom_data: <custom user data object>,
  identities: <array of user identities>,
}

このフィールドを使用して、リクエストが API キーからのものであるかどうかを評価できます。

詳細については、「ユーザー オブジェクト」を参照してください。

サーバー API キー

サーバー API キーは、App Services CLI、API、または UI のいずれかを使用して、サーバーサイドのコンテキストで生成されます。サーバー API キーを作成すると、関連付けられたサーバー ユーザーも作成されます。

外部のアプリケーションやサービスにサーバー キーを提供することで、App Servicesで直接認証できます。

アプリには最大 100 個のサーバー API キーを関連付けることができます。

appservices users create --type=api-key

appservices users create --type=api-key \
  --app=<Your App ID> \
  --name=<API Key Name>

ユーザー API キー

Realm SDK を使用してユーザー API キーを生成できます。各ユーザー API キーは、単一の非匿名ユーザーに関連付けられます。各ユーザーは、最大 20 個のユーザー API キーを自身のアカウントに関連付けることができます。キーがユーザー アカウントに関連付けられると、ユーザーはそのキーを使用して認証できるようになります。次の図は、ユーザー API キーを作成して使用する方法を示しています。

ユーザー API キーを生成する方法については、Realm SDK のドキュメントを参照してください。

Realm SDK の例

API キー認証を使用して登録およびログインする方法を示すコードの例については、Realm SDK のドキュメントを参照してください。